orb-billing 1.0.1 → 1.19.5

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

@@ -1,170 +1,38 @@
 import { SpeakeasyBase } from "../../../internal/utils";
+import { Address } from "./address";
 import { AutoCollection } from "./autocollection";
 import { CreditNoteSummary } from "./creditnotesummary";
+import { CustomerBalanceTransaction } from "./customerbalancetransaction";
 import { CustomerMinified } from "./customerminified";
-import { DiscountType } from "./discounttype";
+import { CustomerTaxId } from "./customertaxid";
 import { InvoiceLineItem } from "./invoicelineitem";
-import { InvoiceStatus } from "./invoicestatus";
+import { Maximum } from "./maximum";
+import { Minimum } from "./minimum";
 import { SubscriptionMinified } from "./subscriptionminified";
-import { Transactions } from "./transactions";
-/**
- * Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.
- *
- * @remarks
- *
- *
- * ### Supported Tax ID Countries and Types
- *
- *
- * | Country        | Type         | Description                                 |
- * |----------------|--------------|---------------------------------------------|
- * | Australia      | `au_abn`     | Australian Business Number (AU ABN)	        |
- * | Australia      | `au_arn`     | Australian Taxation Office Reference Number |
- * | Austria        | `eu_vat`     | European VAT number                         |
- * | Belgium        | `eu_vat`     | European VAT number                         |
- * | Brazil         | `br_cnpj`    | Brazilian CNPJ number                       |
- * | Brazil         | `br_cpf`     | Brazilian CPF number	                       |
- * | Bulgaria       | `bg_uic`     | Bulgaria Unified Identification Code        |
- * | Bulgaria       | `eu_vat`     | European VAT number                         |
- * | Canada         | `ca_bn`      | Canadian BN                                 |
- * | Canada         | `ca_gst_hst` | Canadian GST/HST number                     |
- * | Canada         | `ca_pst_bc`  | Canadian PST number (British Columbia)      |
- * | Canada         | `ca_pst_mb`  | Canadian PST number (Manitoba)              |
- * | Canada         | `ca_pst_sk`  | Canadian PST number (Saskatchewan)          |
- * | Canada         | `ca_qst`     | Canadian QST number (Québec)                |
- * | Chile          | `cl_tin`     | Chilean TIN                                 |
- * | Croatia        | `eu_vat`     | European VAT number                         |
- * | Cyprus         | `eu_vat`     | European VAT number                         |
- * | Czech Republic | `eu_vat`     | European VAT number                         |
- * | Denmark        | `eu_vat`     | European VAT number                         |
- * | Egypt          | `eg_tin`     | Egyptian Tax Identification Number	         |
- * | Estonia   | `eu_vat`     | European VAT number   |
- * | EU        | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme                                                   |
- * | Finland   | `eu_vat`     | European VAT number                                                                                      |
- * | France    | `eu_vat`     | European VAT number                                                                                      |
- * | Georgia   | `ge_vat`     | Georgian VAT                                                                                             |
- * | Germany   | `eu_vat`     | European VAT number                                                                                      |
- * | Greece    | `eu_vat`     | European VAT number                                                                                      |
- * | Hong Kong | `hk_br`      | Hong Kong BR number                                                                                      |
- * | Hungary   | `eu_vat`     | European VAT number                                                                                      |
- * | Hungary   | `hu_tin`     | Hungary tax number (adószám)	                                                                            |
- * | Iceland   | `is_vat`     | Icelandic VAT                                                                                            |
- * | India     | `in_gst`     | Indian GST number                                                                                        |
- * | Indonesia | `id_npwp`    | Indonesian NPWP number                                                                                   |
- * | Ireland   | `eu_vat`     | European VAT number                                                                                      |
- * | Israel    | `il_vat`     | Israel VAT                                                                                               |
- * | Italy     | `eu_vat`     | European VAT number                                                                                      |
- * | Japan     | `jp_cn`      | Japanese Corporate Number (*Hōjin Bangō*)                                                                |
- * | Japan     | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)	 |
- * | Japan     | `jp_trn`     | Japanese Tax Registration Number (*Tōroku Bangō*)	                                                       |
- * | Kenya     | `ke_pin`     | Kenya Revenue Authority Personal Identification Number                                                   |
- * | Latvia    | `eu_vat`     | European VAT number                                                                                  |
- * | Liechtenstein | `li_uid`  | Liechtensteinian UID number           |
- * | Lithuania     | `eu_vat`  | European VAT number	                  |
- * | Luxembourg    | `eu_vat`  | European VAT number	                  |
- * | Malaysia      | `my_frp`  | Malaysian FRP number                  |
- * | Malaysia      | `my_itn`  | Malaysian ITN                         |
- * | Malaysia      | `my_sst`  | Malaysian SST number                  |
- * | Malta         | `eu_vat ` | European VAT number                   |
- * | Mexico        | `mx_rfc`  | Mexican RFC number                    |
- * | Netherlands   | `eu_vat`  | European VAT number	                  |
- * | New Zealand   | `nz_gst`  | New Zealand GST number	               |
- * | Norway        | `no_vat`  | Norwegian VAT number                  |
- * | Philippines   | `ph_tin	` | Philippines Tax Identification Number |
- * | Poland        | `eu_vat`  | European VAT number                   |
- * | Portugal      | `eu_vat`  | European VAT number                   |
- * | Romania       | `eu_vat`  | European VAT number                   |
- * | Russia        | `ru_inn`  | Russian INN                           |
- * | Russia        | `ru_kpp`  | Russian KPP                           |
- * | Saudi Arabia  | `sg_gst`  | Singaporean GST                       |
- * | Singapore     | `sg_uen`  | Singaporean UEN	                      |
- * | Slovakia      | `eu_vat`  | European VAT number                   |
- * | Slovenia      | `eu_vat`  | European VAT number                   |
- * | Slovenia             | `si_tin` | Slovenia tax number (davčna številka)	             |
- * | South Africa	        | `za_vat` | South African VAT number                           |
- * | South Korea          | `kr_brn` | Korean BRN                                         |
- * | Spain                | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
- * | Spain                | `eu_vat` | European VAT number	                               |
- * | Sweden               | `eu_vat` | European VAT number                                |
- * | Switzerland          | `ch_vat` | Switzerland VAT number	                            |
- * | Taiwan               | `tw_vat` | Taiwanese VAT	                                     |
- * | Thailand             | `th_vat` | Thai VAT                                           |
- * | Turkey               | `tr_tin` | Turkish Tax Identification Number                  |
- * | Ukraine              | `ua_vat` | Ukrainian VAT                                      |
- * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN	                          |
- * | United Kingdom       | `eu_vat` | Northern Ireland VAT number                        |
- * | United Kingdom       | `gb_vat` | United Kingdom VAT number                          |
- * | United States        | `us_ein` | United States EIN                                  |
- */
-export declare class InvoiceCustomerTaxID extends SpeakeasyBase {
-    /**
-     * Two-letter ISO code representing the country of the tax ID
-     */
-    country: string;
-    /**
-     * One of `ae_trn`, `au_abn`, `au_arn`, `bg_uic`, `br_cn`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ph_tin`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, or `za_va`
-     */
-    type: string;
-    /**
-     * The value of the ID
-     */
-    value: string;
-}
-export declare class InvoiceDiscount extends SpeakeasyBase {
-    /**
-     * Only available if discount_type is `amount`.
-     */
-    amountDiscount?: string;
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
-     */
-    appliesToPriceIds?: string[];
-    discountType: DiscountType;
-    /**
-     * Only available if discount_type is `percentage`.This is a number between 0 and 1.
-     */
-    percentageDiscount?: number;
-    /**
-     * Only available if discount_type is `trial`
-     */
-    trialAmountDiscount?: string;
-    /**
-     * Only available if discount_type is `usage`. Number of usage units that this discount is for
-     */
-    usageDiscount?: number;
-}
-export declare class InvoiceMaximumAmount extends SpeakeasyBase {
-    /**
-     * List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
-     */
-    appliesToPriceIds: string[];
-    /**
-     * Maximum amount applied
-     */
-    maximumAmount: string;
+export declare class InvoiceMetadata extends SpeakeasyBase {
 }
-export declare class InvoiceMinimumAmount extends SpeakeasyBase {
-    /**
-     * List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
-     */
-    appliesToPriceIds: string[];
-    /**
-     * Minimum amount applied
-     */
-    minimumAmount: string;
+export declare enum InvoiceStatus {
+    Issued = "issued",
+    Paid = "paid",
+    Synced = "synced",
+    Void = "void",
+    Draft = "draft"
 }
 /**
- * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation.
+ * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for
+ *
+ * @remarks
+ * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and
+ * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as
+ * the result of an action, such as a cancellation.
  */
 export declare class Invoice extends SpeakeasyBase {
     /**
      * This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.
      */
     amountDue: string;
-    /**
-     * Information about payment auto-collection for this invoice.
-     */
-    autoCollection?: AutoCollection;
+    autoCollection: AutoCollection;
+    billingAddress: Address;
     /**
      * The creation time of the resource in Orb.
      */
@@ -172,33 +40,31 @@ export declare class Invoice extends SpeakeasyBase {
     /**
      * A list of credit notes associated with the invoice
      */
-    creditNotes?: CreditNoteSummary[];
+    creditNotes: CreditNoteSummary[];
     /**
      * An ISO 4217 currency string or `credits`
      */
     currency: string;
-    /**
-     * The customer receiving this invoice.
-     */
     customer: CustomerMinified;
-    customerBalanceTransactions: Transactions;
-    customerTaxId?: InvoiceCustomerTaxID;
-    discount: InvoiceDiscount;
+    customerBalanceTransactions: CustomerBalanceTransaction[];
+    customerTaxId: CustomerTaxId;
+    discount: any;
+    discounts: any[];
     /**
      * When the invoice payment is due.
      */
     dueDate: Date;
     /**
-     * If the invoice has a status of `draft`, this will be the time that the invoice willl be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time.
+     * If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time.
      */
-    eligibleForIssueAt?: Date;
+    eligibleToIssueAt: Date;
     /**
      * A URL for the invoice portal.
      */
-    hostedInvoiceUrl?: string;
+    hostedInvoiceUrl: string;
     id: string;
     /**
-     * Issue date of the invoice
+     * The scheduled date of the invoice
      */
     invoiceDate: Date;
     /**
@@ -212,44 +78,42 @@ export declare class Invoice extends SpeakeasyBase {
     /**
      * If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)
      */
-    issueFailedAt?: Date;
+    issueFailedAt: Date;
     /**
      * If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)
      */
-    issuedAt?: Date;
+    issuedAt: Date;
     /**
      * The breakdown of prices in this invoice.
      */
     lineItems: InvoiceLineItem[];
-    maximum?: InvoiceMaximumAmount;
+    maximum: Maximum;
+    maximumAmount: string;
     /**
      * Free-form text which is available on the invoice PDF and the Orb invoice portal.
      */
-    memo?: string;
-    minimum: InvoiceMinimumAmount;
+    memo: string;
+    metadata: InvoiceMetadata;
+    minimum: Minimum;
+    minimumAmount: string;
     /**
      * If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid.
      */
-    paidAt?: Date;
+    paidAt: Date;
     /**
      * If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.
      */
-    paymentFailedAt?: Date;
+    paymentFailedAt: Date;
     /**
      * If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.
      */
-    paymentStartedAt?: Date;
+    paymentStartedAt: Date;
     /**
      * If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.
      */
-    scheduledIssueAt?: Date;
-    /**
-     * The status of this invoice as known to Orb. Invoices start in `"draft"` state for a given billing period, and are automatically transitioned to `"issued"` when that billing period ends. Invoices will be marked `"paid"` upon confirmation of successful automatic payment collection by Orb. Invoices may be manually voided; those will be in the terminal `"void"` state. Invoices synced to an external billing provider (such as Bill.com, QuickBooks, or Stripe Invoicing) will be marked as `"synced"`.
-     */
+    scheduledIssueAt: Date;
+    shippingAddress: Address;
     status: InvoiceStatus;
-    /**
-     * The associated subscription for this invoice.
-     */
     subscription: SubscriptionMinified;
     /**
      * The total before any discounts and minimums are applied.
@@ -258,17 +122,17 @@ export declare class Invoice extends SpeakeasyBase {
     /**
      * If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing.
      */
-    syncFailedAt?: Date;
+    syncFailedAt: Date;
     /**
-     * The total after any minimums, discounts, and taxes have been applied.
+     * The total after any minimums and discounts have been applied.
      */
     total: string;
     /**
      * If the invoice has a status of `void`, this gives a timestamp when the invoice was voided.
      */
-    voidedAt?: Date;
+    voidedAt: Date;
     /**
-     * This is true if the invoice will be automaticaly issued in the future, and false otherwise.
+     * This is true if the invoice will be automatically issued in the future, and false otherwise.
      */
     willAutoIssue: boolean;
 }