import { StripeResource } from '../../StripeResource.js';
import { TransactionLineItem } from './TransactionLineItems.js';
import { MetadataParam, PaginationParams, Metadata, Address } from '../../shared.js';
import { RequestOptions, Response, ApiListPromise, ApiList } from '../../lib.js';
export declare class TransactionResource extends StripeResource {
    /**
     * Retrieves a Tax Transaction object.
     */
    retrieve(id: string, params?: Tax.TransactionRetrieveParams, options?: RequestOptions): Promise<Response<Transaction>>;
    /**
     * Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.
     */
    createFromCalculation(params: Tax.TransactionCreateFromCalculationParams, options?: RequestOptions): Promise<Response<Transaction>>;
    /**
     * Partially or fully reverses a previously created Transaction.
     */
    createReversal(params: Tax.TransactionCreateReversalParams, options?: RequestOptions): Promise<Response<Transaction>>;
    /**
     * Retrieves the line items of a committed standalone transaction as a collection.
     */
    listLineItems(id: string, params?: Tax.TransactionListLineItemsParams, options?: RequestOptions): ApiListPromise<TransactionLineItem>;
}
export interface Transaction {
    /**
     * Unique identifier for the transaction.
     */
    id: string;
    /**
     * String representing the object's type. Objects of the same type share the same value.
     */
    object: 'tax.transaction';
    /**
     * Time at which the object was created. Measured in seconds since the Unix epoch.
     */
    created: number;
    /**
     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
     */
    currency: string;
    /**
     * The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource.
     */
    customer: string | null;
    customer_details: Tax.Transaction.CustomerDetails;
    /**
     * The tax collected or refunded, by line item.
     */
    line_items?: ApiList<TransactionLineItem> | null;
    /**
     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     */
    livemode: boolean;
    /**
     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
     */
    metadata: Metadata | null;
    /**
     * The Unix timestamp representing when the tax liability is assumed or reduced.
     */
    posted_at: number;
    /**
     * A custom unique identifier, such as 'myOrder_123'.
     */
    reference: string;
    /**
     * If `type=reversal`, contains information about what was reversed.
     */
    reversal: Tax.Transaction.Reversal | null;
    /**
     * The details of the ship from location, such as the address.
     */
    ship_from_details: Tax.Transaction.ShipFromDetails | null;
    /**
     * The shipping cost details for the transaction.
     */
    shipping_cost: Tax.Transaction.ShippingCost | null;
    /**
     * The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window.
     */
    tax_date: number;
    /**
     * If `reversal`, this transaction reverses an earlier transaction.
     */
    type: Tax.Transaction.Type;
}
export declare namespace Tax {
    namespace Transaction {
        interface CustomerDetails {
            /**
             * The customer's postal address (for example, home or business location).
             */
            address: Address | null;
            /**
             * The type of customer address provided.
             */
            address_source: CustomerDetails.AddressSource | null;
            /**
             * The customer's IP address (IPv4 or IPv6).
             */
            ip_address: string | null;
            /**
             * The customer's tax IDs (for example, EU VAT numbers).
             */
            tax_ids: Array<CustomerDetails.TaxId>;
            /**
             * The taxability override used for taxation.
             */
            taxability_override: CustomerDetails.TaxabilityOverride;
        }
        interface Reversal {
            /**
             * The `id` of the reversed `Transaction` object.
             */
            original_transaction: string | null;
        }
        interface ShipFromDetails {
            address: Address;
        }
        interface ShippingCost {
            /**
             * The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
             */
            amount: number;
            /**
             * The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
             */
            amount_tax: number;
            /**
             * The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object).
             */
            shipping_rate?: string;
            /**
             * Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
             */
            tax_behavior: ShippingCost.TaxBehavior;
            /**
             * Detailed account of taxes relevant to shipping cost. (It is not populated for the transaction resource object and will be removed in the next API version.)
             */
            tax_breakdown?: Array<ShippingCost.TaxBreakdown>;
            /**
             * The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping.
             */
            tax_code: string;
        }
        type Type = 'reversal' | 'transaction';
        namespace CustomerDetails {
            type AddressSource = 'billing' | 'shipping';
            interface TaxId {
                /**
                 * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
                 */
                type: TaxId.Type;
                /**
                 * The value of the tax ID.
                 */
                value: string;
            }
            type TaxabilityOverride = 'customer_exempt' | 'none' | 'reverse_charge';
            namespace TaxId {
                type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
            }
        }
        namespace ShippingCost {
            type TaxBehavior = 'exclusive' | 'inclusive';
            interface TaxBreakdown {
                /**
                 * The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
                 */
                amount: number;
                jurisdiction: TaxBreakdown.Jurisdiction;
                /**
                 * Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
                 */
                sourcing: TaxBreakdown.Sourcing;
                /**
                 * Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
                 */
                tax_rate_details: TaxBreakdown.TaxRateDetails | null;
                /**
                 * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
                 */
                taxability_reason: TaxBreakdown.TaxabilityReason;
                /**
                 * The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
                 */
                taxable_amount: number;
            }
            namespace TaxBreakdown {
                interface Jurisdiction {
                    /**
                     * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
                     */
                    country: string;
                    /**
                     * A human-readable name for the jurisdiction imposing the tax.
                     */
                    display_name: string;
                    /**
                     * Indicates the level of the jurisdiction imposing the tax.
                     */
                    level: Jurisdiction.Level;
                    /**
                     * [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
                     */
                    state: string | null;
                }
                type Sourcing = 'destination' | 'origin';
                interface TaxRateDetails {
                    /**
                     * A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
                     */
                    display_name: string;
                    /**
                     * The tax rate percentage as a string. For example, 8.5% is represented as "8.5".
                     */
                    percentage_decimal: string;
                    /**
                     * The tax type, such as `vat` or `sales_tax`.
                     */
                    tax_type: TaxRateDetails.TaxType;
                }
                type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
                namespace Jurisdiction {
                    type Level = 'city' | 'country' | 'county' | 'district' | 'state';
                }
                namespace TaxRateDetails {
                    type TaxType = 'amusement_tax' | 'communications_tax' | 'gst' | 'hst' | 'igst' | 'jct' | 'lease_tax' | 'pst' | 'qst' | 'retail_delivery_fee' | 'rst' | 'sales_tax' | 'service_tax' | 'vat';
                }
            }
        }
    }
}
export declare namespace Tax {
    interface TransactionRetrieveParams {
        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;
    }
}
export declare namespace Tax {
    interface TransactionCreateFromCalculationParams {
        /**
         * Tax Calculation ID to be used as input when creating the transaction.
         */
        calculation: string;
        /**
         * A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.
         */
        reference: string;
        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;
        /**
         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         */
        metadata?: MetadataParam;
        /**
         * The Unix timestamp representing when the tax liability is assumed or reduced, which determines the liability posting period and handling in tax liability reports. The timestamp must fall within the `tax_date` and the current time, unless the `tax_date` is scheduled in advance. Defaults to the current time.
         */
        posted_at?: number;
    }
}
export declare namespace Tax {
    interface TransactionCreateReversalParams {
        /**
         * If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.
         */
        mode: TransactionCreateReversalParams.Mode;
        /**
         * The ID of the Transaction to partially or fully reverse.
         */
        original_transaction: string;
        /**
         * A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports).
         */
        reference: string;
        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;
        /**
         * A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative. This value represents the total amount to refund from the transaction, including taxes.
         */
        flat_amount?: number;
        /**
         * The line item amounts to reverse.
         */
        line_items?: Array<TransactionCreateReversalParams.LineItem>;
        /**
         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         */
        metadata?: MetadataParam;
        /**
         * The shipping cost to reverse.
         */
        shipping_cost?: TransactionCreateReversalParams.ShippingCost;
    }
    namespace TransactionCreateReversalParams {
        type Mode = 'full' | 'partial';
        interface LineItem {
            /**
             * The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
             */
            amount: number;
            /**
             * The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
             */
            amount_tax: number;
            /**
             * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
             */
            metadata?: MetadataParam;
            /**
             * The `id` of the line item to reverse in the original transaction.
             */
            original_line_item: string;
            /**
             * The quantity reversed. Appears in [tax exports](https://docs.stripe.com/tax/reports), but does not affect the amount of tax reversed.
             */
            quantity?: number;
            /**
             * A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.
             */
            reference: string;
        }
        interface ShippingCost {
            /**
             * The amount to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
             */
            amount: number;
            /**
             * The amount of tax to reverse, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units) in negative.
             */
            amount_tax: number;
        }
    }
}
export declare namespace Tax {
    interface TransactionListLineItemsParams extends PaginationParams {
        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;
    }
}