@codat/lending 4.2.0 → 4.3.0

package/README.md

@@ -38,6 +38,11 @@ async function run() {
 
     const res = await sdk.companies.create({
         description: "Requested early access to the new financing scheme.",
+        groups: [
+            {
+                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+            },
+        ],
         name: "Bank of Dave",
     });
 
@@ -387,6 +392,11 @@ async function run() {
     const res = await sdk.companies.create(
         {
             description: "Requested early access to the new financing scheme.",
+            groups: [
+                {
+                    id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+                },
+            ],
             name: "Bank of Dave",
         },
         {
@@ -433,6 +443,11 @@ async function run() {
 
     const res = await sdk.companies.create({
         description: "Requested early access to the new financing scheme.",
+        groups: [
+            {
+                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+            },
+        ],
         name: "Bank of Dave",
     });
 
@@ -453,7 +468,7 @@ Handling errors in this SDK should largely match your expectations.  All operati
 
 | Error Object    | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 400-600         | */*             |
+| errors.SDKError | 4xx-5xx         | */*             |
 
 Example
 
@@ -471,6 +486,11 @@ async function run() {
     try {
         res = await sdk.companies.create({
             description: "Requested early access to the new financing scheme.",
+            groups: [
+                {
+                    id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+                },
+            ],
             name: "Bank of Dave",
         });
     } catch (err) {
@@ -516,6 +536,11 @@ async function run() {
 
     const res = await sdk.companies.create({
         description: "Requested early access to the new financing scheme.",
+        groups: [
+            {
+                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+            },
+        ],
         name: "Bank of Dave",
     });
 
@@ -545,6 +570,11 @@ async function run() {
 
     const res = await sdk.companies.create({
         description: "Requested early access to the new financing scheme.",
+        groups: [
+            {
+                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+            },
+        ],
         name: "Bank of Dave",
     });
 
@@ -601,6 +631,11 @@ async function run() {
 
     const res = await sdk.companies.create({
         description: "Requested early access to the new financing scheme.",
+        groups: [
+            {
+                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
+            },
+        ],
         name: "Bank of Dave",
     });
 

package/dist/sdk/companies.d.ts

@@ -13,40 +13,55 @@ export declare class Companies {
      * Create company
      *
      * @remarks
-     * Creates a new company that can be used to assign connections to.
-     *
-     * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+     * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/lending-api#/schemas/Company) that represents your customer in Codat.
      *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      *
+     * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
      */
     create(req: shared.CompanyRequestBody, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.CreateCompanyResponse>;
     /**
      * Delete a company
      *
      * @remarks
+     * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      *
-     * Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
      */
     delete(req: operations.DeleteCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.DeleteCompanyResponse>;
     /**
      * Get company
      *
      * @remarks
-     * Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
+     * The *Get company* endpoint returns a single company for a given `companyId`.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+     *
      */
     get(req: operations.GetCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetCompanyResponse>;
     /**
      * List companies
      *
      * @remarks
-     * Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/lending-api#/schemas/Connection) related to the company.
+     * The *List companies* endpoint returns a list of [companies] associated to your instances.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      */
     list(req: operations.ListCompaniesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListCompaniesResponse>;
     /**
      * Update company
      *
      * @remarks
-     * Updates both the name and description of the company.
+     * Use the *Update company* endpoint to update both the name and description of the company.
+     * If you use [groups](https://docs.codat.io/lending-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/lending-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/lending-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      */
     update(req: operations.UpdateCompanyRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.UpdateCompanyResponse>;
 }

package/dist/sdk/companies.js

@@ -105,11 +105,12 @@ var Companies = /** @class */ (function () {
      * Create company
      *
      * @remarks
-     * Creates a new company that can be used to assign connections to.
-     *
-     * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+     * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/lending-api#/schemas/Company) that represents your customer in Codat.
      *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      *
+     * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
      */
     Companies.prototype.create = function (req, retries, config) {
         var _a, _b;
@@ -200,8 +201,11 @@ var Companies = /** @class */ (function () {
      * Delete a company
      *
      * @remarks
+     * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      *
-     * Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
      */
     Companies.prototype.delete = function (req, retries, config) {
         var _a, _b;
@@ -276,7 +280,11 @@ var Companies = /** @class */ (function () {
      * Get company
      *
      * @remarks
-     * Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
+     * The *Get company* endpoint returns a single company for a given `companyId`.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+     *
      */
     Companies.prototype.get = function (req, retries, config) {
         var _a, _b;
@@ -357,7 +365,10 @@ var Companies = /** @class */ (function () {
      * List companies
      *
      * @remarks
-     * Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/lending-api#/schemas/Connection) related to the company.
+     * The *List companies* endpoint returns a list of [companies] associated to your instances.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      */
     Companies.prototype.list = function (req, retries, config) {
         var _a, _b;
@@ -439,7 +450,11 @@ var Companies = /** @class */ (function () {
      * Update company
      *
      * @remarks
-     * Updates both the name and description of the company.
+     * Use the *Update company* endpoint to update both the name and description of the company.
+     * If you use [groups](https://docs.codat.io/lending-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/lending-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/lending-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group.
+     *
+     * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
+     * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
      */
     Companies.prototype.update = function (req, retries, config) {
         var _a, _b;

package/dist/sdk/models/operations/getcreateoperation.d.ts

@@ -7,7 +7,7 @@ export declare class GetCreateOperationRequest extends SpeakeasyBase {
      */
     companyId: string;
     /**
-     * Push operation key.
+     * Unique identifier for the push operation.
      */
     pushOperationKey: string;
 }

package/dist/sdk/models/shared/accountingbillcreditnote.d.ts

@@ -2,10 +2,10 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountingPaymentAllocation } from "./accountingpaymentallocation";
 import { BillCreditNoteLineItem } from "./billcreditnotelineitem";
 import { BillCreditNoteStatus } from "./billcreditnotestatus";
-import { Items } from "./items";
 import { Metadata } from "./metadata";
 import { SupplementalData } from "./supplementaldata";
 import { SupplierRef } from "./supplierref";
+import { WithholdingTaxItems } from "./withholdingtaxitems";
 /**
  * > **Bill credit notes or credit notes?**
  *
@@ -187,5 +187,5 @@ export declare class AccountingBillCreditNote extends SpeakeasyBase {
      * Amount of tax included in the bill credit note.
      */
     totalTaxAmount: number;
-    withholdingTax?: Items[];
+    withholdingTax?: WithholdingTaxItems[];
 }

package/dist/sdk/models/shared/accountingbillcreditnote.js

@@ -32,10 +32,10 @@ var utils_1 = require("../../../internal/utils");
 var accountingpaymentallocation_1 = require("./accountingpaymentallocation");
 var billcreditnotelineitem_1 = require("./billcreditnotelineitem");
 var billcreditnotestatus_1 = require("./billcreditnotestatus");
-var items_1 = require("./items");
 var metadata_1 = require("./metadata");
 var supplementaldata_1 = require("./supplementaldata");
 var supplierref_1 = require("./supplierref");
+var withholdingtaxitems_1 = require("./withholdingtaxitems");
 var class_transformer_1 = require("class-transformer");
 /**
  * > **Bill credit notes or credit notes?**
@@ -173,9 +173,9 @@ var AccountingBillCreditNote = /** @class */ (function (_super) {
         __metadata("design:type", Number)
     ], AccountingBillCreditNote.prototype, "totalTaxAmount", void 0);
     __decorate([
-        (0, utils_1.SpeakeasyMetadata)({ elemType: items_1.Items }),
+        (0, utils_1.SpeakeasyMetadata)({ elemType: withholdingtaxitems_1.WithholdingTaxItems }),
         (0, class_transformer_1.Expose)({ name: "withholdingTax" }),
-        (0, class_transformer_1.Type)(function () { return items_1.Items; }),
+        (0, class_transformer_1.Type)(function () { return withholdingtaxitems_1.WithholdingTaxItems; }),
         __metadata("design:type", Array)
     ], AccountingBillCreditNote.prototype, "withholdingTax", void 0);
     return AccountingBillCreditNote;

package/dist/sdk/models/shared/accountingcreateaccountresponse.d.ts

@@ -1,9 +1,178 @@
 import { SpeakeasyBase } from "../../../internal/utils";
-import { AccountingAccount } from "./accountingaccount";
+import { AccountStatus } from "./accountstatus";
+import { AccountType } from "./accounttype";
 import { DataType } from "./datatype";
+import { Metadata } from "./metadata";
 import { PushOperationChange } from "./pushoperationchange";
 import { PushOperationStatus } from "./pushoperationstatus";
+import { SupplementalData } from "./supplementaldata";
 import { Validation } from "./validation";
+/**
+ * When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.
+ *
+ * @remarks
+ *
+ * For example, `validDatatypeLinks` might indicate the following references:
+ *
+ * - Which tax rates are valid to use on the line item of a bill.
+ * - Which items can be used when creating an invoice.
+ *
+ * You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.
+ *
+ * ## `validDatatypeLinks` example
+ *
+ * The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.
+ *
+ * ```json validDatatypeLinks for an account
+ * {
+ *             "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
+ *             "nominalCode": "090",
+ *             "name": "Business Bank Account",
+ *             #...
+ *             "validDatatypeLinks": [
+ *                 {
+ *                     "property": "Id",
+ *                     "links": [
+ *                         "Payment.AccountRef.Id",
+ *                         "BillPayment.AccountRef.Id",
+ *                         "DirectIncome.LineItems.AccountRef.Id",
+ *                         "DirectCost.LineItems.AccountRef.Id"
+ *                     ]
+ *                 }
+ *             ]
+ *         }
+ * ```
+ *
+ *
+ *
+ * ## Support for `validDatatypeLinks`
+ *
+ * Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations.
+ *
+ * If you'd like us to extend support to more data types or integrations, suggest or vote for this on our <a href="https://portal.productboard.com/codat/5-product-roadmap">Product Roadmap</a>.
+ */
+export declare class AccountingCreateAccountResponseValidDataTypeLinks extends SpeakeasyBase {
+    /**
+     * Supported `dataTypes` that the record can be linked to.
+     */
+    links?: string[];
+    /**
+     * The property from the account that can be linked.
+     */
+    property?: string;
+}
+/**
+ * > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
+ *
+ * @remarks
+ *
+ * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.
+ *
+ * The categories for an account include:
+ * * Asset
+ * * Expense
+ * * Income
+ * * Liability
+ * * Equity.
+ *
+ * The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.
+ *
+ * At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.
+ *
+ * To determine the list of allowed categories for a specific integration, you can:
+ * - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).
+ * - Refer to the integration's own documentation.
+ *
+ * > **Accounts with no category**
+ * >
+ * > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
+ * >
+ * > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export declare class AccountingCreateAccountResponseAccountingAccount extends SpeakeasyBase {
+    /**
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+     *
+     * @remarks
+     *
+     * ## Unknown currencies
+     *
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+     *
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+     */
+    currency?: string;
+    /**
+     * Current balance in the account.
+     */
+    currentBalance?: number;
+    /**
+     * Description for the account.
+     */
+    description?: string;
+    /**
+     * Full category of the account.
+     *
+     * @remarks
+     *
+     * For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation.
+     */
+    fullyQualifiedCategory?: string;
+    /**
+     * Full name of the account, for example:
+     *
+     * @remarks
+     * - `Cash On Hand`
+     * - `Rents Held In Trust`
+     * - `Fixed Asset`
+     */
+    fullyQualifiedName?: string;
+    /**
+     * Identifier for the account, unique for the company.
+     */
+    id?: string;
+    /**
+     * Confirms whether the account is a bank account or not.
+     */
+    isBankAccount?: boolean;
+    metadata?: Metadata;
+    modifiedDate?: string;
+    /**
+     * Name of the account.
+     */
+    name?: string;
+    /**
+     * Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.
+     */
+    nominalCode?: string;
+    sourceModifiedDate?: string;
+    /**
+     * Status of the account
+     */
+    status?: AccountStatus;
+    /**
+     * Supplemental data is additional data you can include in our standard data types.
+     *
+     * @remarks
+     *
+     * 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.
+     */
+    supplementalData?: SupplementalData;
+    /**
+     * Type of account
+     */
+    type?: AccountType;
+    /**
+     * The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/lending-api#/schemas/ValidDataTypeLinks).
+     */
+    validDatatypeLinks?: AccountingCreateAccountResponseValidDataTypeLinks[];
+}
 export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
     /**
      * Contains a single entry that communicates which record has changed and the manner in which it changed.
@@ -37,39 +206,7 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
     completedOnUtc?: string;
-    /**
-     * > **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.
-     *
-     * @remarks
-     *
-     * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
-     *
-     * ## Overview
-     *
-     * Accounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.
-     *
-     * The categories for an account include:
-     * * Asset
-     * * Expense
-     * * Income
-     * * Liability
-     * * Equity.
-     *
-     * The same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.
-     *
-     * At the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.
-     *
-     * To determine the list of allowed categories for a specific integration, you can:
-     * - Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).
-     * - Refer to the integration's own documentation.
-     *
-     * > **Accounts with no category**
-     * >
-     * > If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.
-     * >
-     * > This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports.
-     */
-    data?: AccountingAccount;
+    data?: AccountingCreateAccountResponseAccountingAccount;
     /**
      * Unique identifier for a company's data connection.
      */