yellowgrid-api-ts 3.0.79

package/docs/OAuth20Api.md

@@ -0,0 +1,368 @@
+# OAuth20Api
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetMfaQrCode**](#getgetmfaqrcode) | **GET** /oauth2/qr/code | Get MFA QR Code|
+|[**getGetScopes**](#getgetscopes) | **GET** /oauth2/scopes | Get Scopes|
+|[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
+|[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
+|[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
+
+# **getGetMfaQrCode**
+> string getGetMfaQrCode()
+
+Get MFA QR Code
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.getGetMfaQrCode();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Base 64 encoded QR code PNG |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **getGetScopes**
+> Array<ScopeModel> getGetScopes()
+
+Get Scopes
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.getGetScopes();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ScopeModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Scopes |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **postAccessToken**
+> TokenResponseModel postAccessToken()
+
+Get an OAuth 2.0 access token
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+let clientId: string; //OAuth 2.0 Client ID (optional) (default to undefined)
+let clientSecret: string; //OAuth 2.0 Client Secret (optional) (default to undefined)
+let grantType: string; //OAuth 2.0 Grant Type (optional) (default to undefined)
+let scope: string; //OAuth 2.0 Scope (optional) (default to undefined)
+let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
+let code: string; //OAuth 2.0 Auth Code (optional) (default to undefined)
+let refreshToken: string; //OAuth 2.0 Refresh Token (optional) (default to undefined)
+let codeVerifier: string; //OAuth 2.0 Code Verifier (optional) (default to undefined)
+let token: string; //OAuth 2.0 Token (Only used in Token Exchange) (optional) (default to undefined)
+let tokenExchangeType: string; //Token Exchange Type (Only used in Token Exchange) (optional) (default to undefined)
+let licenceKey: string; //3CX Licence Key (Only used in Token Exchange) (optional) (default to undefined)
+let endUser: boolean; //End User (Only used in Token Exchange) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postAccessToken(
+    clientId,
+    clientSecret,
+    grantType,
+    scope,
+    redirectUri,
+    code,
+    refreshToken,
+    codeVerifier,
+    token,
+    tokenExchangeType,
+    licenceKey,
+    endUser
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
+| **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
+| **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
+| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;sms&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
+| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
+| **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
+| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
+| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
+| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
+| **tokenExchangeType** | [**string**]**Array<&#39;tcx_wizard&#39; &#124; &#39;portal&#39;>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
+| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
+| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
+
+
+### Return type
+
+**TokenResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Token Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **postAuthorise**
+> postAuthorise()
+
+Get an OAuth 2.0 auth code
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+let clientId: string; //OAuth 2.0 Client ID (default to undefined)
+let responseType: string; //OAuth 2.0 Response Type (default to 'code')
+let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'sms'; //OAuth 2.0 Scope (default to undefined)
+let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
+let state: string; //OAuth 2.0 State (optional) (default to undefined)
+let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
+let codeChallengeMethod: string; //OAuth 2.0 Code Challenge Method (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postAuthorise(
+    clientId,
+    responseType,
+    scope,
+    redirectUri,
+    state,
+    codeChallenge,
+    codeChallengeMethod
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
+| **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
+| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;sms&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;sms&#39;>** | OAuth 2.0 Scope | defaults to undefined|
+| **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
+| **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
+| **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|
+| **codeChallengeMethod** | [**string**] | OAuth 2.0 Code Challenge Method | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**302** | Redirect |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **postGetIdentity**
+> ClientDetailsModel postGetIdentity()
+
+Get Token Identity
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postGetIdentity();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ClientDetailsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Access Token |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
+# **postPortalLogin**
+> AuthCodeResponseModel postPortalLogin()
+
+Portal Login
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration,
+    PortalLoginModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+let portalLoginModel: PortalLoginModel; //Login Credentials (optional)
+
+const { status, data } = await apiInstance.postPortalLogin(
+    portalLoginModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portalLoginModel** | **PortalLoginModel**| Login Credentials | |
+
+
+### Return type
+
+**AuthCodeResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Auth Code Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | MFA Not Setup |  -  |
+|**403** | MFA Code Required |  -  |
+
+[[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/OfflineInstancesEntity.md

@@ -0,0 +1,29 @@
+# OfflineInstancesEntity
+
+OfflineInstancesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**offlineSince** | **string** | offlineSince | [optional] [default to undefined]
+**rebooted** | **number** | rebooted | [optional] [default to undefined]
+**alerted** | **number** | alerted | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OfflineInstancesEntity } from 'yellowgrid-api-ts';
+
+const instance: OfflineInstancesEntity = {
+    id,
+    instanceId,
+    offlineSince,
+    rebooted,
+    alerted,
+};
+```
+
+[[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/OrderEntity.md

@@ -0,0 +1,135 @@
+# OrderEntity
+
+OrdersEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**reference** | **string** | externalId | [optional] [default to undefined]
+**sourceId** | **number** | sourceId | [optional] [default to undefined]
+**invoiceNumber** | **string** | sageInv | [optional] [default to undefined]
+**invoiceId** | **string** | invoiceId | [optional] [default to undefined]
+**customerId** | **number** | creditAccountId | [optional] [default to undefined]
+**orderDate** | **string** | orderDate | [optional] [default to undefined]
+**orderPostedDate** | **string** | orderPostedDate | [optional] [default to undefined]
+**buyerEmail** | **string** | buyerEmail | [optional] [default to undefined]
+**buyerPhone** | **string** | buyerPhone | [optional] [default to undefined]
+**buyerName** | **string** | buyerName | [optional] [default to undefined]
+**buyerCompany** | **string** | buyerCompany | [optional] [default to undefined]
+**billName** | **string** | billName | [optional] [default to undefined]
+**billAddress1** | **string** | billAddress1 | [optional] [default to undefined]
+**billAddress2** | **string** | billAddress2 | [optional] [default to undefined]
+**billAddress3** | **string** | billAddress3 | [optional] [default to undefined]
+**billCity** | **string** | billCity | [optional] [default to undefined]
+**billStateRegion** | **string** | billStateRegion | [optional] [default to undefined]
+**billPostalCode** | **string** | billPostalCode | [optional] [default to undefined]
+**billCountry** | **string** | billCountry | [optional] [default to undefined]
+**shipName** | **string** | shipName | [optional] [default to undefined]
+**shipCompany** | **string** | shipCompany | [optional] [default to undefined]
+**shipAddress1** | **string** | shipAddress1 | [optional] [default to undefined]
+**shipAddress2** | **string** | shipAddress2 | [optional] [default to undefined]
+**shipAddress3** | **string** | shipAddress3 | [optional] [default to undefined]
+**shipCity** | **string** | shipCity | [optional] [default to undefined]
+**shipStateRegion** | **string** | shipStateRegion | [optional] [default to undefined]
+**shipPostalCode** | **string** | shipPostalCode | [optional] [default to undefined]
+**shipCountry** | **string** | shipCountry | [optional] [default to undefined]
+**shipVatNumber** | **string** | shipVatNumber | [optional] [default to undefined]
+**shipPhoneNumber** | **string** | shipPhoneNumber | [optional] [default to undefined]
+**shipCourier** | **string** | shipCourier | [optional] [default to undefined]
+**shipMethod** | **string** | shipMethod | [optional] [default to undefined]
+**shipServiceLevel** | **string** | shipServiceLevel | [optional] [default to undefined]
+**shipTrackingId** | **string** | shipTrackingId | [optional] [default to undefined]
+**currency** | **string** | currency | [optional] [default to undefined]
+**taxRate** | **number** | taxRate | [optional] [default to undefined]
+**taxAmount** | **number** | taxAmount | [optional] [default to undefined]
+**taxAmountGbp** | **number** | taxAmountGbp | [optional] [default to undefined]
+**paidStatus** | **number** | paidStatus | [optional] [default to undefined]
+**invoicePaid** | **number** | invoicePaid | [optional] [default to undefined]
+**quote** | **number** | quoteStatus | [optional] [default to undefined]
+**sageStatus** | **string** | sageStatus | [optional] [default to undefined]
+**transactionId** | **string** | transactionId | [optional] [default to undefined]
+**customerInvoiceSent** | **number** | customerInvoiceSent | [optional] [default to undefined]
+**supplierOrderedStatus** | **number** | supplierOrderedStatus | [optional] [default to undefined]
+**supplierPaidStatus** | **number** | supplierPaidStatus | [optional] [default to undefined]
+**supplierReceivedStatus** | **number** | supplierRecvdStatus | [optional] [default to undefined]
+**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
+**amazonMinus** | **number** | amazonMinus | [optional] [default to undefined]
+**currencyRate** | **number** | currencyRate | [optional] [default to undefined]
+**hzStatus** | **number** | hzStatus | [optional] [default to undefined]
+**prospect** | **number** | prospect | [optional] [default to undefined]
+**provisioningUrl** | **number** | provisioningUrl | [optional] [default to undefined]
+**uniqueId** | **string** | uniqueId | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+**promocode** | **string** | promocode | [optional] [default to undefined]
+**fulfillable** | **boolean** | fulfillable | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderEntity } from 'yellowgrid-api-ts';
+
+const instance: OrderEntity = {
+    id,
+    reference,
+    sourceId,
+    invoiceNumber,
+    invoiceId,
+    customerId,
+    orderDate,
+    orderPostedDate,
+    buyerEmail,
+    buyerPhone,
+    buyerName,
+    buyerCompany,
+    billName,
+    billAddress1,
+    billAddress2,
+    billAddress3,
+    billCity,
+    billStateRegion,
+    billPostalCode,
+    billCountry,
+    shipName,
+    shipCompany,
+    shipAddress1,
+    shipAddress2,
+    shipAddress3,
+    shipCity,
+    shipStateRegion,
+    shipPostalCode,
+    shipCountry,
+    shipVatNumber,
+    shipPhoneNumber,
+    shipCourier,
+    shipMethod,
+    shipServiceLevel,
+    shipTrackingId,
+    currency,
+    taxRate,
+    taxAmount,
+    taxAmountGbp,
+    paidStatus,
+    invoicePaid,
+    quote,
+    sageStatus,
+    transactionId,
+    customerInvoiceSent,
+    supplierOrderedStatus,
+    supplierPaidStatus,
+    supplierReceivedStatus,
+    carriageRefunded,
+    amazonMinus,
+    currencyRate,
+    hzStatus,
+    prospect,
+    provisioningUrl,
+    uniqueId,
+    notes,
+    promocode,
+    fulfillable,
+};
+```
+
+[[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/OrderRequestModel.md

@@ -0,0 +1,45 @@
+# OrderRequestModel
+
+EdTechPro Order Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientId** | **number** | Client/Trust ID | [optional] [default to undefined]
+**clientName** | **string** | Client/Trust Name | [optional] [default to undefined]
+**clientContactName** | **string** | Client/Trust Contact Name | [optional] [default to undefined]
+**clientContactEmail** | **string** | Client/Trust Contact Email | [optional] [default to undefined]
+**terms** | **boolean** | Agreed to Terms and Conditions | [optional] [default to undefined]
+**schoolName** | **string** | School Name | [optional] [default to undefined]
+**dfECode** | **string** | School DfE Code | [optional] [default to undefined]
+**schoolContactName** | **string** | School Technical Contact Name | [optional] [default to undefined]
+**schoolContactEmail** | **string** | School Technical Contact Email | [optional] [default to undefined]
+**licenceType** | **string** | Licence Type | [optional] [default to undefined]
+**schoolType** | **string** | School Type | [optional] [default to undefined]
+**instanceId** | **string** | InstanceId | [optional] [default to undefined]
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderRequestModel } from 'yellowgrid-api-ts';
+
+const instance: OrderRequestModel = {
+    clientId,
+    clientName,
+    clientContactName,
+    clientContactEmail,
+    terms,
+    schoolName,
+    dfECode,
+    schoolContactName,
+    schoolContactEmail,
+    licenceType,
+    schoolType,
+    instanceId,
+    orderReference,
+};
+```
+
+[[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/OrderSummariesModel.md

@@ -0,0 +1,27 @@
+# OrderSummariesModel
+
+Sales Orders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<OrderSummaryDTO>**](OrderSummaryDTO.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderSummariesModel } from 'yellowgrid-api-ts';
+
+const instance: OrderSummariesModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/OrderSummaryDTO.md

@@ -0,0 +1,43 @@
+# OrderSummaryDTO
+
+Order Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**reference** | **string** | Reference | [optional] [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**orderDate** | **string** | Date Time | [optional] [default to undefined]
+**paid** | **boolean** | Paid | [optional] [default to undefined]
+**complete** | **boolean** | Complete | [optional] [default to undefined]
+**quote** | **boolean** | Quote | [optional] [default to undefined]
+**customer** | [**AccountSummaryDTO**](AccountSummaryDTO.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
+**carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
+**fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: OrderSummaryDTO = {
+    id,
+    reference,
+    invoiceNumber,
+    orderDate,
+    paid,
+    complete,
+    quote,
+    customer,
+    shippingAddress,
+    items,
+    carriageCharge,
+    fulfillable,
+};
+```
+
+[[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/OrderTotalModel.md

@@ -0,0 +1,33 @@
+# OrderTotalModel
+
+Order Totals
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subtotal** | **number** | Subtotal | [optional] [default to undefined]
+**vat** | **number** | VAT | [optional] [default to undefined]
+**total** | **number** | Total | [optional] [default to undefined]
+**totalGbp** | **number** | Total in GBP | [optional] [default to undefined]
+**vatRate** | **number** | VAT Rate | [optional] [default to undefined]
+**credit** | **number** | Credit | [optional] [default to undefined]
+**currency** | **string** | Currency | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderTotalModel } from 'yellowgrid-api-ts';
+
+const instance: OrderTotalModel = {
+    subtotal,
+    vat,
+    total,
+    totalGbp,
+    vatRate,
+    credit,
+    currency,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)