@codat/lending 3.2.0 → 3.3.0

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

@@ -2,6 +2,7 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountRef } from "./accountref";
 import { BillPaymentLine } from "./billpaymentline";
 import { Metadata } from "./metadata";
+import { PaymentMethodRef } from "./paymentmethodref";
 import { SupplementalData } from "./supplementaldata";
 import { SupplierRef } from "./supplierref";
 /**
@@ -11,13 +12,13 @@ import { SupplierRef } from "./supplierref";
  * >
  * > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.
  * >
- * > See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * > View the coverage for bill payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)).
+ * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).
  *
  * A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:
  *
@@ -34,9 +35,9 @@ import { SupplierRef } from "./supplierref";
  * - Who the payment has been paid to, the _supplier_.
  * - The types of bill payments, the _line items_.
  *
- * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  *
- * Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  * ---
  *
@@ -210,7 +211,7 @@ export declare class AccountingBillPayment extends SpeakeasyBase {
      * Additional information associated with the payment.
      */
     note?: string;
-    paymentMethodRef?: any;
+    paymentMethodRef?: PaymentMethodRef;
     /**
      * Additional information associated with the payment.
      */

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

@@ -32,6 +32,7 @@ var utils_1 = require("../../../internal/utils");
 var accountref_1 = require("./accountref");
 var billpaymentline_1 = require("./billpaymentline");
 var metadata_1 = require("./metadata");
+var paymentmethodref_1 = require("./paymentmethodref");
 var supplementaldata_1 = require("./supplementaldata");
 var supplierref_1 = require("./supplierref");
 var class_transformer_1 = require("class-transformer");
@@ -42,13 +43,13 @@ var class_transformer_1 = require("class-transformer");
  * >
  * > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.
  * >
- * > See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).
+ * > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
  *
  * > View the coverage for bill payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments" target="_blank">Data coverage explorer</a>.
  *
  * ## Overview
  *
- * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)).
+ * Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).
  *
  * A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:
  *
@@ -65,9 +66,9 @@ var class_transformer_1 = require("class-transformer");
  * - Who the payment has been paid to, the _supplier_.
  * - The types of bill payments, the _line items_.
  *
- * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.
+ * Some accounting platforms give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.
  *
- * Bill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+ * Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
  *
  * ---
  *
@@ -246,7 +247,8 @@ var AccountingBillPayment = /** @class */ (function (_super) {
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "paymentMethodRef" }),
-        __metadata("design:type", Object)
+        (0, class_transformer_1.Type)(function () { return paymentmethodref_1.PaymentMethodRef; }),
+        __metadata("design:type", paymentmethodref_1.PaymentMethodRef)
     ], AccountingBillPayment.prototype, "paymentMethodRef", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),

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

@@ -3,8 +3,17 @@ import { AccountingBillPayment } from "./accountingbillpayment";
 import { Links } from "./links";
 export declare class AccountingBillPayments extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBillPayment[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

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

@@ -3,8 +3,17 @@ import { AccountingBill } from "./accountingbill";
 import { Links } from "./links";
 export declare class AccountingBills extends SpeakeasyBase {
     links: Links;
+    /**
+     * Current page number.
+     */
     pageNumber: number;
+    /**
+     * Number of items to return in results array.
+     */
     pageSize: number;
     results?: AccountingBill[];
+    /**
+     * Total number of items.
+     */
     totalResults: number;
 }

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

@@ -1,6 +1,7 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { AccountingAddress } from "./accountingaddress";
 import { PhoneNumber } from "./phonenumber";
+import { SupplementalData } from "./supplementaldata";
 import { WebLink } from "./weblink";
 /**
  * > View the coverage for company info in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=cashFlowStatement" target="_blank">Data coverage explorer</a>.
@@ -122,6 +123,14 @@ export declare class AccountingCompanyInfo extends SpeakeasyBase {
      * For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero).
      */
     sourceUrls?: Record<string, string>;
+    /**
+     * 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;
     /**
      * Company tax number.
      */

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

@@ -31,6 +31,7 @@ exports.AccountingCompanyInfo = void 0;
 var utils_1 = require("../../../internal/utils");
 var accountingaddress_1 = require("./accountingaddress");
 var phonenumber_1 = require("./phonenumber");
+var supplementaldata_1 = require("./supplementaldata");
 var weblink_1 = require("./weblink");
 var class_transformer_1 = require("class-transformer");
 /**
@@ -106,6 +107,12 @@ var AccountingCompanyInfo = /** @class */ (function (_super) {
         (0, class_transformer_1.Expose)({ name: "sourceUrls" }),
         __metadata("design:type", Object)
     ], AccountingCompanyInfo.prototype, "sourceUrls", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "supplementalData" }),
+        (0, class_transformer_1.Type)(function () { return supplementaldata_1.SupplementalData; }),
+        __metadata("design:type", supplementaldata_1.SupplementalData)
+    ], AccountingCompanyInfo.prototype, "supplementalData", void 0);
     __decorate([
         (0, utils_1.SpeakeasyMetadata)(),
         (0, class_transformer_1.Expose)({ name: "taxNumber" }),

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

@@ -60,7 +60,7 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * 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/accounting-api#/operations/get-create-chartOfAccounts-model).
+     * - 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**
@@ -78,6 +78,9 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * Available Data types
      */
     dataType?: DataType;
+    /**
+     * A message about the error.
+     */
     errorMessage?: string;
     /**
      * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
@@ -111,9 +114,17 @@ export declare class AccountingCreateAccountResponse extends SpeakeasyBase {
      * The current status of the push operation.
      */
     status: PushOperationStatus;
+    /**
+     * Push status code.
+     */
     statusCode: number;
+    /**
+     * Number of minutes the push operation must complete within before it times out.
+     */
     timeoutInMinutes?: number;
     /**
+     * Number of seconds the push operation must complete within before it times out.
+     *
      * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     timeoutInSeconds?: number;

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

@@ -1,6 +1,9 @@
 import { SpeakeasyBase } from "../../../internal/utils";
 import { CreateBankAccountTransaction } from "./createbankaccounttransaction";
 export declare class AccountingCreateBankTransactions extends SpeakeasyBase {
+    /**
+     * Unique identifier for a bank account.
+     */
     accountId?: string;
     transactions?: CreateBankAccountTransaction[];
 }

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

@@ -46,6 +46,9 @@ export declare class AccountingCreateBankTransactionsResponse extends SpeakeasyB
      * Available Data types
      */
     dataType?: DataType;
+    /**
+     * A message about the error.
+     */
     errorMessage?: string;
     /**
      * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
@@ -79,9 +82,17 @@ export declare class AccountingCreateBankTransactionsResponse extends SpeakeasyB
      * The current status of the push operation.
      */
     status: PushOperationStatus;
+    /**
+     * Push status code.
+     */
     statusCode: number;
+    /**
+     * Number of minutes the push operation must complete within before it times out.
+     */
     timeoutInMinutes?: number;
     /**
+     * Number of seconds the push operation must complete within before it times out.
+     *
      * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     timeoutInSeconds?: number;

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

@@ -54,7 +54,7 @@ export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
      *   * Withdrawing money from a bank account
      *   * Writing a cheque
      *
-     * Direct costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).
+     * Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
      */
     data?: AccountingDirectCost;
     /**
@@ -65,6 +65,9 @@ export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
      * Available Data types
      */
     dataType?: DataType;
+    /**
+     * A message about the error.
+     */
     errorMessage?: string;
     /**
      * A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.
@@ -98,9 +101,17 @@ export declare class AccountingCreateDirectCostResponse extends SpeakeasyBase {
      * The current status of the push operation.
      */
     status: PushOperationStatus;
+    /**
+     * Push status code.
+     */
     statusCode: number;
+    /**
+     * Number of minutes the push operation must complete within before it times out.
+     */
     timeoutInMinutes?: number;
     /**
+     * Number of seconds the push operation must complete within before it times out.
+     *
      * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     timeoutInSeconds?: number;