@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20250509.1 → 1.20250620.1

package/docs/ClaimOffsetDetailApi.md

@@ -0,0 +1,357 @@
+# ClaimOffsetDetailApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createClaimOffsetDetail**](#createclaimoffsetdetail) | **POST** /claim-offset-details | Create ClaimOffsetDetail|
+|[**deleteClaimOffsetDetail**](#deleteclaimoffsetdetail) | **DELETE** /claim-offset-details/{ClaimOffsetDetail_Key} | Delete ClaimOffsetDetail|
+|[**getClaimOffsetDetail**](#getclaimoffsetdetail) | **GET** /claim-offset-details/{ClaimOffsetDetail_Key} | Get ClaimOffsetDetail|
+|[**listClaimOffsetDetail**](#listclaimoffsetdetail) | **GET** /claim-offset-details | List ClaimOffsetDetail|
+|[**updateBatchClaimOffsetDetail**](#updatebatchclaimoffsetdetail) | **PUT** /claim-offset-details-batch | Create or Update Batch ClaimOffsetDetail|
+|[**updateClaimOffsetDetail**](#updateclaimoffsetdetail) | **PUT** /claim-offset-details/{ClaimOffsetDetail_Key} | Update ClaimOffsetDetail|
+
+# **createClaimOffsetDetail**
+> ClaimOffsetDetailVBAResponse createClaimOffsetDetail(claimOffsetDetail)
+
+Creates a new ClaimOffsetDetail
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration,
+    ClaimOffsetDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetDetail: ClaimOffsetDetail; //
+
+const { status, data } = await apiInstance.createClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **claimOffsetDetail** | **ClaimOffsetDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**ClaimOffsetDetailVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteClaimOffsetDetail**
+> deleteClaimOffsetDetail()
+
+Deletes an ClaimOffsetDetail
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetDetailKey: number; //ClaimOffsetDetail Key (default to undefined)
+
+const { status, data } = await apiInstance.deleteClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetDetailKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **claimOffsetDetailKey** | [**number**] | ClaimOffsetDetail Key | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getClaimOffsetDetail**
+> ClaimOffsetDetailVBAResponse getClaimOffsetDetail()
+
+Gets ClaimOffsetDetail
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetDetailKey: number; //ClaimOffsetDetail Key (default to undefined)
+
+const { status, data } = await apiInstance.getClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetDetailKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **claimOffsetDetailKey** | [**number**] | ClaimOffsetDetail Key | defaults to undefined|
+
+
+### Return type
+
+**ClaimOffsetDetailVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listClaimOffsetDetail**
+> ClaimOffsetDetailListVBAResponse listClaimOffsetDetail()
+
+Lists all ClaimOffsetDetail with optional ClaimOffset_Key query parameter to filter results.
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetKey: number; //ClaimOffset Key (optional) (default to undefined)
+let sortBy: string; //Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. (optional) (default to undefined)
+let page: number; //Page (optional) (default to 1)
+let pageSize: number; //Page Size (optional) (default to 100)
+
+const { status, data } = await apiInstance.listClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetKey,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **claimOffsetKey** | [**number**] | ClaimOffset Key | (optional) defaults to undefined|
+| **sortBy** | [**string**] | Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., \'Property1:desc,Property2:asc,Property3:asc\' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending. | (optional) defaults to undefined|
+| **page** | [**number**] | Page | (optional) defaults to 1|
+| **pageSize** | [**number**] | Page Size | (optional) defaults to 100|
+
+
+### Return type
+
+**ClaimOffsetDetailListVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateBatchClaimOffsetDetail**
+> MultiCodeResponseListVBAResponse updateBatchClaimOffsetDetail(claimOffsetDetail)
+
+Create or Update multiple ClaimOffsetDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetDetail: Array<ClaimOffsetDetail>; //
+
+const { status, data } = await apiInstance.updateBatchClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **claimOffsetDetail** | **Array<ClaimOffsetDetail>**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**MultiCodeResponseListVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**207** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateClaimOffsetDetail**
+> ClaimOffsetDetailVBAResponse updateClaimOffsetDetail(claimOffsetDetail)
+
+Updates a specific ClaimOffsetDetail.
+
+### Example
+
+```typescript
+import {
+    ClaimOffsetDetailApi,
+    Configuration,
+    ClaimOffsetDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ClaimOffsetDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let claimOffsetDetailKey: number; //ClaimOffsetDetail Key (default to undefined)
+let claimOffsetDetail: ClaimOffsetDetail; //
+
+const { status, data } = await apiInstance.updateClaimOffsetDetail(
+    vbasoftwareDatabase,
+    claimOffsetDetailKey,
+    claimOffsetDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **claimOffsetDetail** | **ClaimOffsetDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **claimOffsetDetailKey** | [**number**] | ClaimOffsetDetail Key | defaults to undefined|
+
+
+### Return type
+
+**ClaimOffsetDetailVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ClaimOffsetDetailListVBAResponse.md

@@ -0,0 +1,24 @@
+# ClaimOffsetDetailListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ClaimOffsetDetail>**](ClaimOffsetDetail.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClaimOffsetDetailListVBAResponse } from './api';
+
+const instance: ClaimOffsetDetailListVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ClaimOffsetDetailVBAResponse.md

@@ -0,0 +1,24 @@
+# ClaimOffsetDetailVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ClaimOffsetDetail**](ClaimOffsetDetail.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClaimOffsetDetailVBAResponse } from './api';
+
+const instance: ClaimOffsetDetailVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ClaimOffsetListVBAResponse.md

@@ -0,0 +1,24 @@
+# ClaimOffsetListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ClaimOffset>**](ClaimOffset.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClaimOffsetListVBAResponse } from './api';
+
+const instance: ClaimOffsetListVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ClaimOffsetVBAResponse.md

@@ -0,0 +1,24 @@
+# ClaimOffsetVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ClaimOffset**](ClaimOffset.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClaimOffsetVBAResponse } from './api';
+
+const instance: ClaimOffsetVBAResponse = {
+    data,
+    error,
+    debug,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ClaimsApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
 # **createClaim**
 > ClaimVBAResponse createClaim(claim)
 
-Creates a new Claim
+WARNING: The underlying Claim table and this API are used for claims that have already passed through the adjudication process and have been paid.                               Note: If you are looking for Claims that have not yet been processed through adjudication, use the ClaimBatches, ClaimBatch and ClaimBatchDetail APIs.
 
 ### Example
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createClaim(
 # **deleteClaim**
 > deleteClaim()
 
-Deletes an Claim
+WARNING: The underlying Claim table and this API are used for claims that have already passed through the adjudication process and have been paid.                       Note: If you are looking for Claims that have not yet been processed through adjudication, use the ClaimBatches, ClaimBatch and ClaimBatchDetail APIs.
 
 ### Example
 
@@ -125,7 +125,7 @@ void (empty response body)
 # **getClaim**
 > ClaimVBAResponse getClaim()
 
-Gets Claim
+WARNING: The underlying Claim table and this API are used for claims that have already passed through the adjudication process and have been paid.                       Note: If you are looking for Claims that have not yet been processed through adjudication, use the ClaimBatches, ClaimBatch and ClaimBatchDetail APIs.
 
 ### Example
 
@@ -238,7 +238,7 @@ const { status, data } = await apiInstance.listClaimTimeline(
 # **updateBatchClaim**
 > MultiCodeResponseListVBAResponse updateBatchClaim(claim)
 
-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.
+WARNING: The underlying Claim table and this API are used for claims that have already passed through the adjudication process and have been paid. 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.                              Note: If you are looking for Claims that have not yet been processed through adjudication, use the ClaimBatches, ClaimBatch and ClaimBatchDetail APIs.
 
 ### Example
 
@@ -293,7 +293,7 @@ const { status, data } = await apiInstance.updateBatchClaim(
 # **updateClaim**
 > ClaimVBAResponse updateClaim(claim)
 
-Updates a specific Claim.
+WARNING: The underlying Claim table and this API are used for claims that have already passed through the adjudication process and have been paid.                       Note: If you are looking for Claims that have not yet been processed through adjudication, use the ClaimBatches, ClaimBatch and ClaimBatchDetail APIs.
 
 ### Example
 

package/docs/CompanyData.md

@@ -450,6 +450,7 @@ Name | Type | Description | Notes
 **remove_Sys_Gen_Billing_Adj_On_Delete** | **boolean** |  | [optional] [default to undefined]
 **allow_CallTracking_Provider_ID_Edit** | **boolean** |  | [optional] [default to undefined]
 **allow_Candidate_Below_Account_Balance** | **boolean** |  | [optional] [default to undefined]
+**enable_VBAssist** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -902,6 +903,7 @@ const instance: CompanyData = {
     remove_Sys_Gen_Billing_Adj_On_Delete,
     allow_CallTracking_Provider_ID_Edit,
     allow_Candidate_Below_Account_Balance,
+    enable_VBAssist,
 };
 ```
 

package/docs/FundingReconciliationsApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
 |[**reconcileFunds**](#reconcilefunds) | **POST** /funding-reconciliation-reconcile-funds | Reconcile Funds|
 |[**updateBatchFundingReconcile**](#updatebatchfundingreconcile) | **PUT** /funding-reconciliations-batch | Create or Update Batch FundingReconcile|
 |[**updateFundingReconcile**](#updatefundingreconcile) | **PUT** /funding-reconciliations/{reconcileKey} | Update FundingReconcile|
+|[**voidReconcile**](#voidreconcile) | **POST** /void-reconciliation/{reconcileKey} | Void Reconciliation|
 
 # **addReconciliation**
 > FundingReconcileVBAResponse addReconciliation(fundingStatement)
@@ -466,3 +467,58 @@ const { status, data } = await apiInstance.updateFundingReconcile(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **voidReconcile**
+> FundingReconcileVBAResponse voidReconcile()
+
+Void the selected Funding Reconciliation.
+
+### Example
+
+```typescript
+import {
+    FundingReconciliationsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FundingReconciliationsApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reconcileKey: number; //Reconcile Key (default to undefined)
+
+const { status, data } = await apiInstance.voidReconcile(
+    vbasoftwareDatabase,
+    reconcileKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reconcileKey** | [**number**] | Reconcile Key | defaults to undefined|
+
+
+### Return type
+
+**FundingReconcileVBAResponse**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/FundingRequestClaimRemove.md

@@ -0,0 +1,38 @@
+# FundingRequestClaimRemove
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batch_Number** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**batch_Claim** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**request_Key** | **number** | Note: This field is marked as NOT NULL in the database and therefore required by the API. | [default to undefined]
+**entry_Date** | **string** | Date record was first added to the system | [optional] [default to undefined]
+**entry_User** | **string** | User that first added the record to the system | [optional] [default to undefined]
+**remove_Date** | **string** |  | [optional] [default to undefined]
+**remove_Reason** | **string** |  | [optional] [default to undefined]
+**remove_User** | **string** |  | [optional] [default to undefined]
+**update_Date** | **string** | Date the record was last updated in the system | [optional] [default to undefined]
+**update_User** | **string** | User that last updated the record in the system | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FundingRequestClaimRemove } from './api';
+
+const instance: FundingRequestClaimRemove = {
+    batch_Number,
+    batch_Claim,
+    request_Key,
+    entry_Date,
+    entry_User,
+    remove_Date,
+    remove_Reason,
+    remove_User,
+    update_Date,
+    update_User,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)