@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20251017.1 → 1.20260102.1

package/docs/ReportRequestInvoiceDetailApi.md

@@ -0,0 +1,366 @@
+# ReportRequestInvoiceDetailApi
+
+All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createReportRequestInvoiceDetail**](#createreportrequestinvoicedetail) | **POST** /report-request-invoice-detail | Create ReportRequestInvoiceDetail|
+|[**deleteReportRequestInvoiceDetail**](#deletereportrequestinvoicedetail) | **DELETE** /report-request-invoice/{ReportRequestInvoice_Key}/detail/{Request_Seq} | Delete ReportRequestInvoiceDetail|
+|[**getReportRequestInvoiceDetail**](#getreportrequestinvoicedetail) | **GET** /report-request-invoice/{ReportRequestInvoice_Key}/detail/{Request_Seq} | Get ReportRequestInvoiceDetail|
+|[**listReportRequestInvoiceDetail**](#listreportrequestinvoicedetail) | **GET** /report-request-invoice/{ReportRequestInvoice_Key}/detail | List ReportRequestInvoiceDetail|
+|[**updateBatchReportRequestInvoiceDetail**](#updatebatchreportrequestinvoicedetail) | **PUT** /report-request-invoice-detail-batch | Create or Update Batch ReportRequestInvoiceDetail|
+|[**updateReportRequestInvoiceDetail**](#updatereportrequestinvoicedetail) | **PUT** /report-request-invoice/{ReportRequestInvoice_Key}/detail/{Request_Seq} | Update ReportRequestInvoiceDetail|
+
+# **createReportRequestInvoiceDetail**
+> ReportRequestInvoiceDetailVBAResponse createReportRequestInvoiceDetail(reportRequestInvoiceDetail)
+
+Creates a new ReportRequestInvoiceDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration,
+    ReportRequestInvoiceDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceDetail: ReportRequestInvoiceDetail; //
+
+const { status, data } = await apiInstance.createReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestInvoiceDetail** | **ReportRequestInvoiceDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestInvoiceDetailVBAResponse**
+
+### 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)
+
+# **deleteReportRequestInvoiceDetail**
+> deleteReportRequestInvoiceDetail()
+
+Deletes an ReportRequestInvoiceDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceKey: number; //ReportRequestInvoice Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+
+const { status, data } = await apiInstance.deleteReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceKey,
+    requestSeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestInvoiceKey** | [**number**] | ReportRequestInvoice Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request Seq | 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)
+
+# **getReportRequestInvoiceDetail**
+> ReportRequestInvoiceDetailVBAResponse getReportRequestInvoiceDetail()
+
+Gets ReportRequestInvoiceDetail
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceKey: number; //ReportRequestInvoice Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+
+const { status, data } = await apiInstance.getReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceKey,
+    requestSeq
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestInvoiceKey** | [**number**] | ReportRequestInvoice Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request Seq | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestInvoiceDetailVBAResponse**
+
+### 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)
+
+# **listReportRequestInvoiceDetail**
+> ReportRequestInvoiceDetailListVBAResponse listReportRequestInvoiceDetail()
+
+Lists all ReportRequestInvoiceDetail for the given ReportRequestInvoice_Key
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceKey: number; //ReportRequestInvoice Key (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.listReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceKey,
+    sortBy,
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestInvoiceKey** | [**number**] | ReportRequestInvoice Key | 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
+
+**ReportRequestInvoiceDetailListVBAResponse**
+
+### 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)
+
+# **updateBatchReportRequestInvoiceDetail**
+> MultiCodeResponseListVBAResponse updateBatchReportRequestInvoiceDetail(reportRequestInvoiceDetail)
+
+Create or Update multiple ReportRequestInvoiceDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceDetail: Array<ReportRequestInvoiceDetail>; //
+
+const { status, data } = await apiInstance.updateBatchReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestInvoiceDetail** | **Array<ReportRequestInvoiceDetail>**|  | |
+| **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)
+
+# **updateReportRequestInvoiceDetail**
+> ReportRequestInvoiceDetailVBAResponse updateReportRequestInvoiceDetail(reportRequestInvoiceDetail)
+
+Updates a specific ReportRequestInvoiceDetail.
+
+### Example
+
+```typescript
+import {
+    ReportRequestInvoiceDetailApi,
+    Configuration,
+    ReportRequestInvoiceDetail
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportRequestInvoiceDetailApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportRequestInvoiceKey: number; //ReportRequestInvoice Key (default to undefined)
+let requestSeq: number; //Request Seq (default to undefined)
+let reportRequestInvoiceDetail: ReportRequestInvoiceDetail; //
+
+const { status, data } = await apiInstance.updateReportRequestInvoiceDetail(
+    vbasoftwareDatabase,
+    reportRequestInvoiceKey,
+    requestSeq,
+    reportRequestInvoiceDetail
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestInvoiceDetail** | **ReportRequestInvoiceDetail**|  | |
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportRequestInvoiceKey** | [**number**] | ReportRequestInvoice Key | defaults to undefined|
+| **requestSeq** | [**number**] | Request Seq | defaults to undefined|
+
+
+### Return type
+
+**ReportRequestInvoiceDetailVBAResponse**
+
+### 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/ReportRequestInvoiceDetailListVBAResponse.md

@@ -0,0 +1,24 @@
+# ReportRequestInvoiceDetailListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ReportRequestInvoiceDetail>**](ReportRequestInvoiceDetail.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestInvoiceDetailListVBAResponse } from './api';
+
+const instance: ReportRequestInvoiceDetailListVBAResponse = {
+    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/ReportRequestInvoiceDetailVBAResponse.md

@@ -0,0 +1,24 @@
+# ReportRequestInvoiceDetailVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ReportRequestInvoiceDetail**](ReportRequestInvoiceDetail.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestInvoiceDetailVBAResponse } from './api';
+
+const instance: ReportRequestInvoiceDetailVBAResponse = {
+    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/ReportRequestInvoiceListVBAResponse.md

@@ -0,0 +1,24 @@
+# ReportRequestInvoiceListVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ReportRequestInvoice>**](ReportRequestInvoice.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestInvoiceListVBAResponse } from './api';
+
+const instance: ReportRequestInvoiceListVBAResponse = {
+    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/ReportRequestInvoiceVBAResponse.md

@@ -0,0 +1,24 @@
+# ReportRequestInvoiceVBAResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**ReportRequestInvoice**](ReportRequestInvoice.md) |  | [optional] [default to undefined]
+**error** | [**VBAProblemDetails**](VBAProblemDetails.md) |  | [optional] [default to undefined]
+**debug** | [**Debug**](Debug.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestInvoiceVBAResponse } from './api';
+
+const instance: ReportRequestInvoiceVBAResponse = {
+    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/ReportSeriesApi.md

@@ -10,7 +10,9 @@ All URIs are relative to *https://vbapi.vbasoftware.com/vbasoftware*
 |[**listReportSeries**](#listreportseries) | **GET** /report-series | List ReportSeries|
 |[**listReportSeriesUsers**](#listreportseriesusers) | **GET** /report-series-users | List ReportSeries Users|
 |[**processCorrespondenceTrack**](#processcorrespondencetrack) | **POST** /process-correspondence-track-by-step | Process Correspondence Tracking for Step|
+|[**reportSeriesProcessByKey**](#reportseriesprocessbykey) | **POST** /process-automation-process-series-by-key/{reportSeriesKey} | Process a single ReportSeries Key|
 |[**reportSeriesProcessByStep**](#reportseriesprocessbystep) | **POST** /process-automation-process-series-by-step | Process a single ReportSeriesStep|
+|[**reportSeriesProcessByStepKey**](#reportseriesprocessbystepkey) | **POST** /process-automation-process-series-by-step-key/{reportSeriesStepKey} | Process a single ReportSeriesStep Key|
 |[**updateBatchReportSeries**](#updatebatchreportseries) | **PUT** /report-series-batch | Create or Update Batch ReportSeries|
 |[**updateReportSeries**](#updatereportseries) | **PUT** /report-series/{reportSeriesKey} | Update ReportSeries|
 
@@ -361,6 +363,61 @@ const { status, data } = await apiInstance.processCorrespondenceTrack(
 
 [[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)
 
+# **reportSeriesProcessByKey**
+> reportSeriesProcessByKey()
+
+Sometimes Process Automation fails and need to be re-executed.  Use this API to fire an existing Process Automation by key.
+
+### Example
+
+```typescript
+import {
+    ReportSeriesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportSeriesApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportSeriesKey: number; //ReportSeries Key (default to undefined)
+
+const { status, data } = await apiInstance.reportSeriesProcessByKey(
+    vbasoftwareDatabase,
+    reportSeriesKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportSeriesKey** | [**number**] | ReportSeries 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 |
+|-------------|-------------|------------------|
+|**202** | Accepted for processing |  -  |
+|**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)
+
 # **reportSeriesProcessByStep**
 > reportSeriesProcessByStep(reportSeriesStep)
 
@@ -409,6 +466,61 @@ void (empty response body)
  - **Accept**: Not defined
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Accepted for processing |  -  |
+|**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)
+
+# **reportSeriesProcessByStepKey**
+> reportSeriesProcessByStepKey()
+
+Sometimes Process Automation Steps fail and need to be re-executed.  Use this API to fire an existing Process Automation Step by key.
+
+### Example
+
+```typescript
+import {
+    ReportSeriesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new ReportSeriesApi(configuration);
+
+let vbasoftwareDatabase: string; //Target database (default to undefined)
+let reportSeriesStepKey: number; //ReportSeriesStep Key (default to undefined)
+
+const { status, data } = await apiInstance.reportSeriesProcessByStepKey(
+    vbasoftwareDatabase,
+    reportSeriesStepKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **vbasoftwareDatabase** | [**string**] | Target database | defaults to undefined|
+| **reportSeriesStepKey** | [**number**] | ReportSeriesStep 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 |
 |-------------|-------------|------------------|

package/docs/Signature.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **signature_File** | **string** | Location and name of the file that contains the signature | [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]
+**signature_Image** | **string** |  | [optional] [default to undefined]
+**signature_Image_Type** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -28,6 +30,8 @@ const instance: Signature = {
     signature_File,
     update_Date,
     update_User,
+    signature_Image,
+    signature_Image_Type,
 };
 ```