@codat/lending 4.2.0 → 4.3.0

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

@@ -1,725 +1,847 @@
 import { SpeakeasyBase } from "../../../internal/utils";
-import { AccountingPayment } from "./accountingpayment";
+import { AccountingCustomerRef } from "./accountingcustomerref";
+import { AccountRef } from "./accountref";
 import { DataType } from "./datatype";
+import { Metadata } from "./metadata";
+import { PaymentLine } from "./paymentline";
+import { PaymentMethodRef } from "./paymentmethodref";
 import { PushOperationChange } from "./pushoperationchange";
 import { PushOperationStatus } from "./pushoperationstatus";
+import { SupplementalData } from "./supplementaldata";
 import { Validation } from "./validation";
-export declare class AccountingCreatePaymentResponse extends SpeakeasyBase {
+/**
+ * > **Payments or bill payments?**
+ *
+ * @remarks
+ * >
+ * >  In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.
+ *
+ * > View the coverage for payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
+ *
+ * A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:
+ *
+ * - A payment made against an invoice, like a credit card, cheque, or cash payment.
+ * - An allocation of a customer's credit note, either to an invoice or maybe a refund.
+ * - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.
+ *
+ * Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details.
+ *
+ * In Codat, a payment contains details of:
+ *
+ * - When the payment was recorded in the accounting system.
+ * - How much it is for and in what currency that amount is in.
+ * - Who the payment was _paid by_ – the _customer_.
+ * - The payment method used.
+ * - The breakdown of the types of payments – the _line items_.
+ *
+ * Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
+ *
+ * ## Payment types
+ *
+ * ## Payment of an invoice
+ *
+ * A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:
+ *
+ * - An _amount_ that indicates the amount of the invoice that was paid. This is always positive.
+ * - A **links** array containing one element with the following properties:
+ *     - A **type** that indicates the type of **link**, in this case an `Invoice`.
+ *     - An **id** that contains the ID of the invoice that was paid.
+ *     - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.
+ *
+ * The **amount** field on the **line** equals the **totalAmount** on the payment.
+ *
+ * ## Payment of multiple invoices
+ *
+ * A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:
+ *
+ * - The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).
+ * - The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.
+ *
+ * Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.
+ *
+ * ## Payments and refunds on account
+ *
+ * A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:
+ *
+ * - A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.
+ * - A **links** array containing one element with the following properties:
+ * - A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.
+ * - The **id** containing the ID of the customer.
+ * - The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.
+ *
+ * It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.
+ *
+ * ## Using a credit note to pay an invoice
+ *
+ * The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:
+ *
+ * - An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.
+ * - A **links** array containing two elements:
+ *     - The first **link** has:
+ *         - A **type** that indicates the type of **link**, in this case an `Invoice`.
+ *         - An **id** that contains the ID of the invoice that was paid.
+ *     - The second **link** has:
+ *         - A **type** that indicates the type of **link**, in this case a `CreditNote`.
+ *         - An **id** that contains the ID of the credit note used by this payment.
+ *
+ * The **amount** field on the **line** equals the **totalAmount** on the payment.
+ *
+ * ## Refunding a credit note
+ *
+ * A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:
+ *
+ * - An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.
+ * - A **links** array that contains one element with the following properties:
+ *     - A **type** that indicates the type of **link**, in this case a `CreditNote`.
+ *     - An **id** that contains the ID of the credit note that was refunded.
+ *
+ * The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.
+ *
+ * ## Refunding a payment
+ *
+ * If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:
+ *
+ * - One for the incoming over payment.
+ * - Another for the outgoing refund.
+ *
+ * The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:
+ *
+ * - An **amount** that indicates the amount that was refunded. This is always negative.
+ * - A **links** array that contains one element with the following properties:
+ *     - A **type** that indicates the type of **link**, in this case a `Payment`.
+ *     - An **id** that contains the ID of the payment that was refunded.
+ *
+ * The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.
+ *
+ * The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.
+ *
+ * For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:
+ *
+ * - One for £1,000 linked to the invoice that was paid.
+ * - Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.
+ *
+ * The **line** linked to the payment has the following properties:
+ *
+ * - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
+ * - A **links** array containing one element with the following properties:
+ *     - A **type** that indicates the type of **link**, in this case a `Refund`.
+ *     - An **id** that contains the ID of the payment that refunded this line.
+ *
+ * > **Support for linked payments**
+ * >
+ * > Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.
+ *
+ * ## Foreign currencies
+ *
+ * There are two types of currency rate that are included in the payments data type:
+ *
+ * Payment currency rate:
+ *
+ * - Base currency of the accounts receivable account.
+ * - Foreign currency of the payment.
+ *
+ * Payment line link currency rate:
+ *
+ * - Base currency of the item the link represents.
+ * - Foreign currency of the payment.
+ *
+ * These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
+ *
+ * - The base currency for the accounts receivable account.
+ * - The currency of the item.
+ *
+ *   ```json title="Currency rate example"
+ *   {
+ *       "id": "123",
+ *       "note": "",
+ *       "totalAmount": 99.99,
+ *       "currency": "GBP",
+ *       "lines": [
+ *           {
+ *               "amount": 99.99,
+ *               "links": [
+ *                   {
+ *                       "type": "Invoice",
+ *                       "id": "178",
+ *                       "amount": -50,
+ *                       "currencyRate":  1.9998
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ * ## Example data
+ *
+ * > **Object properties**
+ * >
+ * > For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).
+ *
+ * ## Simple examples
+ *
+ *   ```json title="Payment for invoice"
+ *   {
+ *       "totalAmount": 1000,
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Allocation of credit note"
+ *   {
+ *       "totalAmount": 0,
+ *       "lines": [
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Payment of invoice and payment on account"
+ *   {
+ *       "totalAmount": 2000,
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "PaymentOnAccount",
+ *                       "id" : "y",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Refund of credit note"
+ *   {
+ *       "totalAmount": -1000,
+ *       "lines": [
+ *           {
+ *               "amount" : -1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Refund on accounts receivable account"
+ *   {
+ *       "totalAmount": -1000,
+ *       "lines": [
+ *           {
+ *               "amount" : -1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "PaymentOnAccount",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Linked refund on accounts receivable account"
+ *   {
+ *       "id" : "payment-001",
+ *       "totalAmount": 1000,
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Refund",
+ *                       "id" : "refund-001",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   {
+ *       "id" : "refund-001",
+ *       "totalAmount": -1000,
+ *       "lines": [
+ *           {
+ *               "amount" : -1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Payment",
+ *                       "id" : "payment-001",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Using a credit note and cash to pay an invoice"
+ *   {
+ *       "totalAmount": 250,
+ *       "lines": [
+ *           {
+ *               "amount": 0,
+ *               "links": [
+ *                   {
+ *                       "type": "Invoice",
+ *                       "id": "x",
+ *                       "amount": -750
+ *                   },
+ *                   {
+ *                       "type": "CreditNote",
+ *                       "id": "y",
+ *                       "amount": 750
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount": 250,
+ *               "links": [
+ *                   {
+ *                       "type": "Invoice",
+ *                       "id": "x",
+ *                       "amount": -250
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ * ## Complex examples
+ *
+ *   ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
+ *   {
+ *       "totalAmount": 1000,
+ *       "lines": [
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "z",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
+ *   {
+ *       "totalAmount": 2000,
+ *       "lines": [
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "z",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "PaymentOnAccount",
+ *                       "id" : "customer-001",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Two credit notes pay two invoices with no allocation amount specified"
+ *   {
+ *       "totalAmount": 0,
+ *       "lines": [
+ *           {
+ *               "amount" : 0,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "w",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "z",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
+ *   {
+ *       "totalAmount": 2000,
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "w",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "x",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "u",
+ *                       "amount" : -1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "y",
+ *                       "amount" : 1000
+ *                   },
+ *                   {
+ *                       "type" : "CreditNote",
+ *                       "id" : "z",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Refund",
+ *                       "id" : "refund-001",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   {
+ *       "id" : "refund-001",
+ *       "totalAmount": -1000,
+ *       "lines": [
+ *           {
+ *               "amount" : -1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Payment",
+ *                       "id" : "payment-001",
+ *                       "amount" : 1000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ * In this example, a payment on account is used to pay the same invoice in January and again in February.
+ *
+ *   ```json title="January"
+ *   {
+ *       "id": "001",
+ *       "totalAmount": 5000,
+ *       "date" : "1901-01-01",
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "Invoice-x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 4000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "PaymentOnAccount",
+ *                       "id" : "PaymentOnAccount-y",
+ *                       "amount" : -4000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="February"
+ *   {
+ *       "id": "001",
+ *       "totalAmount": 5000,
+ *       "date" : "1901-02-01",
+ *       "lines": [
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "Invoice-x",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 1000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "Invoice",
+ *                       "id" : "Invoice-y",
+ *                       "amount" : -1000
+ *                   }
+ *               ]
+ *           },
+ *           {
+ *               "amount" : 3000,
+ *               "links" : [
+ *                   {
+ *                       "type" : "PaymentOnAccount",
+ *                       "id" : "PaymentOnAccount-y",
+ *                       "amount" : -3000
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ *
+ *
+ *   ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
+ *   {
+ *       "totalAmount": 500,
+ *       "lines": [
+ *           {
+ *               "amount": 500,
+ *               "links": [{
+ *                       "type": "Invoice",
+ *                       "id": "a",
+ *                       "amount": -1000
+ *                   }, {
+ *                       "type": "Invoice",
+ *                       "id": "b",
+ *                       "amount": -1000
+ *                   }, {
+ *                       "type": "CreditNote",
+ *                       "id": "y",
+ *                       "amount": 750
+ *                   },{
+ *                       "type": "CreditNote",
+ *                       "id": "z",
+ *                       "amount": 750
+ *                   }
+ *               ]
+ *           }
+ *       ]
+ *   }
+ *   ```
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export declare class AccountingCreatePaymentResponseAccountingPayment extends SpeakeasyBase {
     /**
-     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     * Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.
      */
-    changes?: PushOperationChange[];
-    /**
-     * Unique identifier for your SMB in Codat.
-     */
-    companyId: string;
+    accountRef?: AccountRef;
     /**
-     * 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:
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
      *
      * @remarks
      *
-     * ```
-     * 2020-10-08T22:40:50Z
-     * 2021-01-01T00:00:00
-     * ```
-     *
-     *
+     * ## Unknown currencies
      *
-     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
      *
-     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
-     * - Unqualified local time: `2021-11-15T01:00:00`
-     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
-     *
-     * > Time zones
-     * >
-     * > Not all dates from Codat will contain information about time zones.
-     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
      */
-    completedOnUtc?: string;
+    currency?: string;
     /**
-     * > **Payments or bill payments?**
+     * Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.
      *
      * @remarks
-     * >
-     * >  In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.
-     *
-     * > View the coverage for payments in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments" target="_blank">Data coverage explorer</a>.
-     *
-     * ## Overview
-     *
-     * Payments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).
      *
-     * A payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:
+     * Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.
      *
-     * - A payment made against an invoice, like a credit card, cheque, or cash payment.
-     * - An allocation of a customer's credit note, either to an invoice or maybe a refund.
-     * - A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.
+     * It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.
      *
-     * Depending on the payments allowed by the underlying accounting package, some payment types may be combined. Please see the example for more details.
+     * Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).
      *
-     * In Codat, a payment contains details of:
+     * For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.
      *
-     * - When the payment was recorded in the accounting system.
-     * - How much it is for and in what currency that amount is in.
-     * - Who the payment was _paid by_ – the _customer_.
-     * - The payment method used.
-     * - The breakdown of the types of payments – the _line items_.
+     * ## Examples with base currency of GBP
      *
-     * Payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).
+     * | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |
+     * | :--------------- | :------------- | :------------ | :------------------------- |
+     * | **USD**          | $20            | 0.781         | £15.62                     |
+     * | **EUR**          | €20            | 0.885         | £17.70                     |
+     * | **RUB**          | ₽20            | 0.011         | £0.22                      |
      *
-     * ## Payment types
+     * ## Examples with base currency of USD
      *
-     * ## Payment of an invoice
+     * | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |
+     * | :--------------- | :------------- | :------------ | :------------------------- |
+     * | **GBP**          | £20            | 1.277         | $25.54                     |
+     * | **EUR**          | €20            | 1.134         | $22.68                     |
+     * | **RUB**          | ₽20            | 0.015         | $0.30                      |
      *
-     * A payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:
      *
-     * - An _amount_ that indicates the amount of the invoice that was paid. This is always positive.
-     * - A **links** array containing one element with the following properties:
-     *     - A **type** that indicates the type of **link**, in this case an `Invoice`.
-     *     - An **id** that contains the ID of the invoice that was paid.
-     *     - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.
+     * ### Integration-specific details
      *
-     * The **amount** field on the **line** equals the **totalAmount** on the payment.
-     *
-     * ## Payment of multiple invoices
-     *
-     * A single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:
-     *
-     * - The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).
-     * - The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.
-     *
-     * Each **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.
-     *
-     * ## Payments and refunds on account
-     *
-     * A payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:
-     *
-     * - A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.
-     * - A **links** array containing one element with the following properties:
-     * - A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.
-     * - The **id** containing the ID of the customer.
-     * - The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.
-     *
-     * It is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.
-     *
-     * ## Using a credit note to pay an invoice
-     *
-     * The payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:
-     *
-     * - An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.
-     * - A **links** array containing two elements:
-     *     - The first **link** has:
-     *         - A **type** that indicates the type of **link**, in this case an `Invoice`.
-     *         - An **id** that contains the ID of the invoice that was paid.
-     *     - The second **link** has:
-     *         - A **type** that indicates the type of **link**, in this case a `CreditNote`.
-     *         - An **id** that contains the ID of the credit note used by this payment.
-     *
-     * The **amount** field on the **line** equals the **totalAmount** on the payment.
-     *
-     * ## Refunding a credit note
-     *
-     * A payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:
-     *
-     * - An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.
-     * - A **links** array that contains one element with the following properties:
-     *     - A **type** that indicates the type of **link**, in this case a `CreditNote`.
-     *     - An **id** that contains the ID of the credit note that was refunded.
-     *
-     * The **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.
-     *
-     * ## Refunding a payment
-     *
-     * If a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:
-     *
-     * - One for the incoming over payment.
-     * - Another for the outgoing refund.
-     *
-     * The payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:
-     *
-     * - An **amount** that indicates the amount that was refunded. This is always negative.
-     * - A **links** array that contains one element with the following properties:
-     *     - A **type** that indicates the type of **link**, in this case a `Payment`.
-     *     - An **id** that contains the ID of the payment that was refunded.
+     * | Integration       | Scenario                                        | System behavior                                                                                                                                                      |
+     * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+     * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction.  |
+     */
+    currencyRate?: number;
+    customerRef?: AccountingCustomerRef;
+    /**
+     * 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:
      *
-     * The **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.
+     * @remarks
      *
-     * The payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
      *
-     * For example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:
      *
-     * - One for £1,000 linked to the invoice that was paid.
-     * - Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.
      *
-     * The **line** linked to the payment has the following properties:
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
      *
-     * - An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.
-     * - A **links** array containing one element with the following properties:
-     *     - A **type** that indicates the type of **link**, in this case a `Refund`.
-     *     - An **id** that contains the ID of the payment that refunded this line.
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
      *
-     * > **Support for linked payments**
+     * > Time zones
      * >
-     * > Not all accounting packages support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.
-     *
-     * ## Foreign currencies
-     *
-     * There are two types of currency rate that are included in the payments data type:
-     *
-     * Payment currency rate:
-     *
-     * - Base currency of the accounts receivable account.
-     * - Foreign currency of the payment.
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    date: string;
+    /**
+     * Identifier for the payment, unique to the company in the accounting platform.
+     */
+    id?: string;
+    /**
+     * An array of payment lines.
+     */
+    lines?: PaymentLine[];
+    metadata?: Metadata;
+    modifiedDate?: string;
+    /**
+     * Any additional information associated with the payment.
+     */
+    note?: string;
+    /**
+     * The payment method the record is linked to in the accounting or commerce platform.
+     */
+    paymentMethodRef?: PaymentMethodRef;
+    /**
+     * Friendly reference for the payment.
+     */
+    reference?: string;
+    sourceModifiedDate?: string;
+    /**
+     * Supplemental data is additional data you can include in our standard data types.
      *
-     * Payment line link currency rate:
+     * @remarks
      *
-     * - Base currency of the item the link represents.
-     * - Foreign currency of the payment.
+     * 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;
+    /**
+     * Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account.
+     */
+    totalAmount?: number;
+}
+export declare class AccountingCreatePaymentResponse extends SpeakeasyBase {
+    /**
+     * Contains a single entry that communicates which record has changed and the manner in which it changed.
+     */
+    changes?: PushOperationChange[];
+    /**
+     * Unique identifier for your SMB in Codat.
+     */
+    companyId: string;
+    /**
+     * 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:
      *
-     * These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:
+     * @remarks
      *
-     * - The base currency for the accounts receivable account.
-     * - The currency of the item.
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
      *
-     *   ```json title="Currency rate example"
-     *   {
-     *       "id": "123",
-     *       "note": "",
-     *       "totalAmount": 99.99,
-     *       "currency": "GBP",
-     *       "lines": [
-     *           {
-     *               "amount": 99.99,
-     *               "links": [
-     *                   {
-     *                       "type": "Invoice",
-     *                       "id": "178",
-     *                       "amount": -50,
-     *                       "currencyRate":  1.9998
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
      *
      *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
      *
-     * ## Example data
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
      *
-     * > **Object properties**
+     * > Time zones
      * >
-     * > For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).
-     *
-     * ## Simple examples
-     *
-     *   ```json title="Payment for invoice"
-     *   {
-     *       "totalAmount": 1000,
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Allocation of credit note"
-     *   {
-     *       "totalAmount": 0,
-     *       "lines": [
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Payment of invoice and payment on account"
-     *   {
-     *       "totalAmount": 2000,
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "PaymentOnAccount",
-     *                       "id" : "y",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Refund of credit note"
-     *   {
-     *       "totalAmount": -1000,
-     *       "lines": [
-     *           {
-     *               "amount" : -1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Refund on accounts receivable account"
-     *   {
-     *       "totalAmount": -1000,
-     *       "lines": [
-     *           {
-     *               "amount" : -1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "PaymentOnAccount",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Linked refund on accounts receivable account"
-     *   {
-     *       "id" : "payment-001",
-     *       "totalAmount": 1000,
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Refund",
-     *                       "id" : "refund-001",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   {
-     *       "id" : "refund-001",
-     *       "totalAmount": -1000,
-     *       "lines": [
-     *           {
-     *               "amount" : -1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Payment",
-     *                       "id" : "payment-001",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Using a credit note and cash to pay an invoice"
-     *   {
-     *       "totalAmount": 250,
-     *       "lines": [
-     *           {
-     *               "amount": 0,
-     *               "links": [
-     *                   {
-     *                       "type": "Invoice",
-     *                       "id": "x",
-     *                       "amount": -750
-     *                   },
-     *                   {
-     *                       "type": "CreditNote",
-     *                       "id": "y",
-     *                       "amount": 750
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount": 250,
-     *               "links": [
-     *                   {
-     *                       "type": "Invoice",
-     *                       "id": "x",
-     *                       "amount": -250
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     * ## Complex examples
-     *
-     *   ```json title="Use two credit notes and 1000 in to "bank" (cash, cheque etc.) to pay invoice"
-     *   {
-     *       "totalAmount": 1000,
-     *       "lines": [
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "z",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Pay an invoice with two credit notes and cash, with 1000 left 'on account'"
-     *   {
-     *       "totalAmount": 2000,
-     *       "lines": [
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "z",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "PaymentOnAccount",
-     *                       "id" : "customer-001",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Two credit notes pay two invoices with no allocation amount specified"
-     *   {
-     *       "totalAmount": 0,
-     *       "lines": [
-     *           {
-     *               "amount" : 0,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "w",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "z",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash"
-     *   {
-     *       "totalAmount": 2000,
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "w",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "x",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "u",
-     *                       "amount" : -1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "y",
-     *                       "amount" : 1000
-     *                   },
-     *                   {
-     *                       "type" : "CreditNote",
-     *                       "id" : "z",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Refund",
-     *                       "id" : "refund-001",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   {
-     *       "id" : "refund-001",
-     *       "totalAmount": -1000,
-     *       "lines": [
-     *           {
-     *               "amount" : -1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Payment",
-     *                       "id" : "payment-001",
-     *                       "amount" : 1000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     * In this example, a payment on account is used to pay the same invoice in January and again in February.
-     *
-     *   ```json title="January"
-     *   {
-     *       "id": "001",
-     *       "totalAmount": 5000,
-     *       "date" : "1901-01-01",
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "Invoice-x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 4000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "PaymentOnAccount",
-     *                       "id" : "PaymentOnAccount-y",
-     *                       "amount" : -4000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="February"
-     *   {
-     *       "id": "001",
-     *       "totalAmount": 5000,
-     *       "date" : "1901-02-01",
-     *       "lines": [
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "Invoice-x",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 1000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "Invoice",
-     *                       "id" : "Invoice-y",
-     *                       "amount" : -1000
-     *                   }
-     *               ]
-     *           },
-     *           {
-     *               "amount" : 3000,
-     *               "links" : [
-     *                   {
-     *                       "type" : "PaymentOnAccount",
-     *                       "id" : "PaymentOnAccount-y",
-     *                       "amount" : -3000
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
-     *
-     *
-     *
-     *   ```json title="Two credit notes and some cash pay two invoices with no allocations specified"
-     *   {
-     *       "totalAmount": 500,
-     *       "lines": [
-     *           {
-     *               "amount": 500,
-     *               "links": [{
-     *                       "type": "Invoice",
-     *                       "id": "a",
-     *                       "amount": -1000
-     *                   }, {
-     *                       "type": "Invoice",
-     *                       "id": "b",
-     *                       "amount": -1000
-     *                   }, {
-     *                       "type": "CreditNote",
-     *                       "id": "y",
-     *                       "amount": 750
-     *                   },{
-     *                       "type": "CreditNote",
-     *                       "id": "z",
-     *                       "amount": 750
-     *                   }
-     *               ]
-     *           }
-     *       ]
-     *   }
-     *   ```
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
      */
-    data?: AccountingPayment;
+    completedOnUtc?: string;
+    data?: AccountingCreatePaymentResponseAccountingPayment;
     /**
      * Unique identifier for a company's data connection.
      */