@codat/lending 3.2.0 → 4.0.0

package/docs/sdk/models/shared/commercepaymentmethod.md

@@ -0,0 +1,16 @@
+# CommercePaymentMethod
+
+A Payment Method represents the payment method(s) used to make payments.
+
+Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-paymentMethods) for this data type.
+
+
+## Fields
+
+| Field                                                                                           | Type                                                                                            | Required                                                                                        | Description                                                                                     | Example                                                                                         |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `id`                                                                                            | *string*                                                                                        | :heavy_check_mark:                                                                              | A unique, persistent identifier for this record                                                 | 13d946f0-c5d5-42bc-b092-97ece17923ab                                                            |
+| `modifiedDate`                                                                                  | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             | 2022-10-23T00:00:00.000Z                                                                        |
+| `name`                                                                                          | *string*                                                                                        | :heavy_minus_sign:                                                                              | The name of the PaymentMethod                                                                   | Alipay                                                                                          |
+| `sourceModifiedDate`                                                                            | *string*                                                                                        | :heavy_minus_sign:                                                                              | N/A                                                                                             | 2022-10-23T00:00:00.000Z                                                                        |
+| `status`                                                                                        | [shared.CommercePaymentMethodStatus](../../../sdk/models/shared/commercepaymentmethodstatus.md) | :heavy_minus_sign:                                                                              | Status of the Payment Method.                                                                   |                                                                                                 |

package/docs/sdk/models/shared/commercepaymentmethods.md

@@ -0,0 +1,12 @@
+# CommercePaymentMethods
+
+
+## Fields
+
+| Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `links`                                                                               | [shared.Links](../../../sdk/models/shared/links.md)                                   | :heavy_check_mark:                                                                    | N/A                                                                                   |
+| `pageNumber`                                                                          | *number*                                                                              | :heavy_check_mark:                                                                    | Current page number.                                                                  |
+| `pageSize`                                                                            | *number*                                                                              | :heavy_check_mark:                                                                    | Number of items to return in results array.                                           |
+| `results`                                                                             | [shared.CommercePaymentMethod](../../../sdk/models/shared/commercepaymentmethod.md)[] | :heavy_minus_sign:                                                                    | N/A                                                                                   |
+| `totalResults`                                                                        | *number*                                                                              | :heavy_check_mark:                                                                    | Total number of items.                                                                |

package/docs/sdk/models/shared/commercepaymentmethodstatus.md

@@ -0,0 +1,12 @@
+# CommercePaymentMethodStatus
+
+Status of the Payment Method.
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `Unknown`  | Unknown    |
+| `Active`   | Active     |
+| `Archived` | Archived   |

package/docs/sdk/models/shared/commercepayments.md

@@ -0,0 +1,12 @@
+# CommercePayments
+
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `links`                                                                   | [shared.Links](../../../sdk/models/shared/links.md)                       | :heavy_check_mark:                                                        | N/A                                                                       |
+| `pageNumber`                                                              | *number*                                                                  | :heavy_check_mark:                                                        | Current page number.                                                      |
+| `pageSize`                                                                | *number*                                                                  | :heavy_check_mark:                                                        | Number of items to return in results array.                               |
+| `results`                                                                 | [shared.CommercePayment](../../../sdk/models/shared/commercepayment.md)[] | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `totalResults`                                                            | *number*                                                                  | :heavy_check_mark:                                                        | Total number of items.                                                    |

package/docs/sdk/models/shared/commerceproduct.md

@@ -0,0 +1,19 @@
+# CommerceProduct
+
+A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale.
+
+Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-products) for this data type.
+
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                       | Type                                                                                                                                                                                                                                                                                        | Required                                                                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                                                                 | Example                                                                                                                                                                                                                                                                                     |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `categorization`                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | Retail category that the product is assigned to e.g. `Hardware`.                                                                                                                                                                                                                            | Hardware                                                                                                                                                                                                                                                                                    |
+| `description`                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | Description of the product recorded in the commerce or point of sale platform.                                                                                                                                                                                                              | 1tb Western Digital Hard Drive                                                                                                                                                                                                                                                              |
+| `id`                                                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                                    | :heavy_check_mark:                                                                                                                                                                                                                                                                          | A unique, persistent identifier for this record                                                                                                                                                                                                                                             | 13d946f0-c5d5-42bc-b092-97ece17923ab                                                                                                                                                                                                                                                        |
+| `isGiftCard`                                                                                                                                                                                                                                                                                | *boolean*                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | Whether the product represents a gift card or voucher that<br/>can be redeemed in the commerce or POS platform.<br/>                                                                                                                                                                        |                                                                                                                                                                                                                                                                                             |
+| `name`                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | Name of the product in the commerce or POS system                                                                                                                                                                                                                                           | Hard Drive                                                                                                                                                                                                                                                                                  |
+| `supplementalData`                                                                                                                                                                                                                                                                          | [shared.SupplementalData](../../../sdk/models/shared/supplementaldata.md)                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | Supplemental data is additional data you can include in our standard data types. <br/><br/>It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. |                                                                                                                                                                                                                                                                                             |
+| `variants`                                                                                                                                                                                                                                                                                  | [shared.ProductVariant](../../../sdk/models/shared/productvariant.md)[]                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                          | N/A                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                             |

package/docs/sdk/models/shared/commerceproductcategories.md

@@ -0,0 +1,12 @@
+# CommerceProductCategories
+
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `links`                                                                                   | [shared.Links](../../../sdk/models/shared/links.md)                                       | :heavy_check_mark:                                                                        | N/A                                                                                       |
+| `pageNumber`                                                                              | *number*                                                                                  | :heavy_check_mark:                                                                        | Current page number.                                                                      |
+| `pageSize`                                                                                | *number*                                                                                  | :heavy_check_mark:                                                                        | Number of items to return in results array.                                               |
+| `results`                                                                                 | [shared.CommerceProductCategory](../../../sdk/models/shared/commerceproductcategory.md)[] | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `totalResults`                                                                            | *number*                                                                                  | :heavy_check_mark:                                                                        | Total number of items.                                                                    |

package/docs/sdk/models/shared/commerceproductcategory.md

@@ -0,0 +1,17 @@
+# CommerceProductCategory
+
+Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.
+
+Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-productCategories) for this data type.
+
+
+## Fields
+
+| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              | Example                                                                                                  |
+| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| `ancestorRefs`                                                                                           | [shared.CommerceRecordRef](../../../sdk/models/shared/commercerecordref.md)[]                            | :heavy_minus_sign:                                                                                       | A collection of parent product categories implicitly ordered with the immediate parent last in the list. |                                                                                                          |
+| `hasChildren`                                                                                            | *boolean*                                                                                                | :heavy_minus_sign:                                                                                       | A boolean indicating whether there are other product categories beneath this one in the hierarchy.       |                                                                                                          |
+| `id`                                                                                                     | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | The unique identifier of the product category                                                            | "102"                                                                                                    |
+| `modifiedDate`                                                                                           | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | N/A                                                                                                      | 2022-10-23T00:00:00.000Z                                                                                 |
+| `name`                                                                                                   | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | The name of the product category                                                                         | Entertainment                                                                                            |
+| `sourceModifiedDate`                                                                                     | *string*                                                                                                 | :heavy_minus_sign:                                                                                       | N/A                                                                                                      | 2022-10-23T00:00:00.000Z                                                                                 |

package/docs/sdk/models/shared/commerceproducts.md

@@ -0,0 +1,12 @@
+# CommerceProducts
+
+
+## Fields
+
+| Field                                                                     | Type                                                                      | Required                                                                  | Description                                                               |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `links`                                                                   | [shared.Links](../../../sdk/models/shared/links.md)                       | :heavy_check_mark:                                                        | N/A                                                                       |
+| `pageNumber`                                                              | *number*                                                                  | :heavy_check_mark:                                                        | Current page number.                                                      |
+| `pageSize`                                                                | *number*                                                                  | :heavy_check_mark:                                                        | Number of items to return in results array.                               |
+| `results`                                                                 | [shared.CommerceProduct](../../../sdk/models/shared/commerceproduct.md)[] | :heavy_minus_sign:                                                        | N/A                                                                       |
+| `totalResults`                                                            | *number*                                                                  | :heavy_check_mark:                                                        | Total number of items.                                                    |

package/docs/sdk/models/shared/commercereport.md

@@ -0,0 +1,54 @@
+# CommerceReport
+
+## Structure
+
+Assess reports follow a consistent structure. Reports contain four sections of information:
+
+### 1. Report definition
+
+Information such as:
+
+  1. The report info (e.g. enhanced_profit_and_loss).
+  2. The display name of the report (e.g. Enhanced Profit and Loss).
+  
+### 2. Dimension info
+
+Information about the dimension contained in the reports such as:
+
+  1. The type of dimension (e.g. datetime, recordRef).
+  2. The display name of the dimension (e.g. Period, Category type, Category sub type).
+  3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"...").
+
+### 3. Measure info
+
+Information about the measures contained in the report such as:
+
+  1. The display name of the measure (e.g. value of account, percentage change).
+  2. The type of the measure (e.g. currency, percentage).
+  3. The unit of the measure (e.g. %, GBP).
+  
+### 4. The data for the report
+
+When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*.
+
+
+## Displaying the report
+
+Reports can be rendered as follows (ordering is implicit rather than explicit):
+
+![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png)
+
+# Data model
+
+## Dimensions
+
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `dimensions`                                                                              | [shared.CommerceReportDimension](../../../sdk/models/shared/commercereportdimension.md)[] | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `errors`                                                                                  | [shared.CommerceReportError](../../../sdk/models/shared/commercereporterror.md)[]         | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `measures`                                                                                | [shared.CommerceReportMeasure](../../../sdk/models/shared/commercereportmeasure.md)[]     | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `reportData`                                                                              | [shared.CommerceReportComponent](../../../sdk/models/shared/commercereportcomponent.md)[] | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `reportInfo`                                                                              | Record<string, *string*>                                                                  | :heavy_minus_sign:                                                                        | N/A                                                                                       |

package/docs/sdk/models/shared/commercereportcomponent.md

@@ -0,0 +1,13 @@
+# CommerceReportComponent
+
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `components`                                                                              | [shared.CommerceReportComponent](../../../sdk/models/shared/commercereportcomponent.md)[] | :heavy_minus_sign:                                                                        | N/A                                                                                       |
+| `dimension`                                                                               | *number*                                                                                  | :heavy_minus_sign:                                                                        | The component's dimension.                                                                |
+| `dimensionDisplayName`                                                                    | *string*                                                                                  | :heavy_minus_sign:                                                                        | The component's display name.                                                             |
+| `item`                                                                                    | *number*                                                                                  | :heavy_minus_sign:                                                                        | The component's item number.                                                              |
+| `itemDisplayName`                                                                         | *string*                                                                                  | :heavy_minus_sign:                                                                        | The component's item display name.                                                        |
+| `measures`                                                                                | [shared.ReportComponentMeasure](../../../sdk/models/shared/reportcomponentmeasure.md)[]   | :heavy_minus_sign:                                                                        | N/A                                                                                       |

package/docs/sdk/models/shared/commercereportdimension.md

@@ -0,0 +1,11 @@
+# CommerceReportDimension
+
+
+## Fields
+
+| Field                                                                                               | Type                                                                                                | Required                                                                                            | Description                                                                                         |
+| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `displayName`                                                                                       | *string*                                                                                            | :heavy_minus_sign:                                                                                  | The dimension's display name.                                                                       |
+| `index`                                                                                             | *number*                                                                                            | :heavy_minus_sign:                                                                                  | The dimension's index.                                                                              |
+| `items`                                                                                             | [shared.CommerceReportDimensionItems](../../../sdk/models/shared/commercereportdimensionitems.md)[] | :heavy_minus_sign:                                                                                  | N/A                                                                                                 |
+| `type`                                                                                              | *string*                                                                                            | :heavy_minus_sign:                                                                                  | The dimension's type.                                                                               |

package/docs/sdk/models/shared/commercereportdimensionitems.md

@@ -0,0 +1,8 @@
+# CommerceReportDimensionItems
+
+
+## Fields
+
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `index`                      | *number*                     | :heavy_minus_sign:           | The dimension's items index. |

package/docs/sdk/models/shared/commercereporterror.md

@@ -0,0 +1,10 @@
+# CommerceReportError
+
+
+## Fields
+
+| Field                            | Type                             | Required                         | Description                      |
+| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
+| `details`                        | Record<string, *string*[]>       | :heavy_minus_sign:               | Additional details on the error. |
+| `message`                        | *string*                         | :heavy_minus_sign:               | Message returned by error.       |
+| `type`                           | *string*                         | :heavy_minus_sign:               | The type of error.               |

package/docs/sdk/models/shared/commercereportmeasure.md

@@ -0,0 +1,11 @@
+# CommerceReportMeasure
+
+
+## Fields
+
+| Field                                    | Type                                     | Required                                 | Description                              |
+| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
+| `displayName`                            | *string*                                 | :heavy_minus_sign:                       | The measure's display name.              |
+| `index`                                  | *number*                                 | :heavy_minus_sign:                       | The measure's index.                     |
+| `type`                                   | *string*                                 | :heavy_minus_sign:                       | The measure's type.                      |
+| `units`                                  | *string*                                 | :heavy_minus_sign:                       | The measure's units e.g. percentage (%). |

package/docs/sdk/models/shared/commercetransaction.md

@@ -0,0 +1,29 @@
+# CommerceTransaction
+
+Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees.
+
+You can use data from the Transactions endpoints to calculate key metrics, such as:  
+- Transaction volumes  
+- Average transaction volume  
+- Average transaction value  
+- Returns  
+- Payouts
+
+Explore our [data coverage](https://knowledge.codat.io/supported-features/commerce?view=tab-by-data-type&dataType=commerce-transactions) for this data type.
+
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `createdDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones.  <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `currency`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.<br/><br/>## Unknown currencies<br/><br/>In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. <br/><br/>There are only a very small number of edge cases where this currency code is returned by the Codat system.                                                                                                                                                                                                                                                                                                                                                                                                                | GBP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| `id`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | A unique, persistent identifier for this record                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | 13d946f0-c5d5-42bc-b092-97ece17923ab                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| `modifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 2022-10-23T00:00:00.000Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `sourceCreatedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones.  <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `sourceModifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 2022-10-23T00:00:00.000Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `subType`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Non-standardised transaction type data from the commerce platform                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | CardPayment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `supplementalData`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [shared.SupplementalData](../../../sdk/models/shared/supplementaldata.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Supplemental data is additional data you can include in our standard data types. <br/><br/>It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `totalAmount`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | *number*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | The total transaction amount                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | 194.12                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `transactionSourceRef`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [shared.TransactionSourceRef](../../../sdk/models/shared/transactionsourceref.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Link to the source event which triggered this transaction                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `type`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [shared.TransactionType](../../../sdk/models/shared/transactiontype.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | The type of the platform transaction:  <br/>- `Unknown`  <br/>- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.  <br/>- `Payment` — Credit and debit card payments.  <br/>- `PaymentFee` — Payment provider's fee on each card payment.  <br/>- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.  <br/>- `Payout` — Transfer of funds from the seller's merchant account to their bank account.  <br/>- `Refund` — Refunds to a customer's credit or debit card.  <br/>- `Transfer` — Secure transfer of funds to the seller's bank account.                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

package/docs/sdk/models/shared/commercetransactions.md

@@ -0,0 +1,12 @@
+# CommerceTransactions
+
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `links`                                                                           | [shared.Links](../../../sdk/models/shared/links.md)                               | :heavy_check_mark:                                                                | N/A                                                                               |
+| `pageNumber`                                                                      | *number*                                                                          | :heavy_check_mark:                                                                | Current page number.                                                              |
+| `pageSize`                                                                        | *number*                                                                          | :heavy_check_mark:                                                                | Number of items to return in results array.                                       |
+| `results`                                                                         | [shared.CommerceTransaction](../../../sdk/models/shared/commercetransaction.md)[] | :heavy_minus_sign:                                                                | N/A                                                                               |
+| `totalResults`                                                                    | *number*                                                                          | :heavy_check_mark:                                                                | Total number of items.                                                            |

package/docs/sdk/models/shared/companies.md

@@ -0,0 +1,12 @@
+# Companies
+
+
+## Fields
+
+| Field                                                     | Type                                                      | Required                                                  | Description                                               |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `links`                                                   | [shared.Links](../../../sdk/models/shared/links.md)       | :heavy_check_mark:                                        | N/A                                                       |
+| `pageNumber`                                              | *number*                                                  | :heavy_check_mark:                                        | Current page number.                                      |
+| `pageSize`                                                | *number*                                                  | :heavy_check_mark:                                        | Number of items to return in results array.               |
+| `results`                                                 | [shared.Company](../../../sdk/models/shared/company.md)[] | :heavy_minus_sign:                                        | N/A                                                       |
+| `totalResults`                                            | *number*                                                  | :heavy_check_mark:                                        | Total number of items.                                    |