Stripe.Resources.Tax.Transaction (tiger_stripe v0.3.0)

@type customer_details() :: %{
  optional(:address) => customer_details_address() | nil,
  optional(:address_source) => String.t() | nil,
  optional(:ip_address) => String.t() | nil,
  optional(:tax_ids) => [customer_details_tax_ids()] | nil,
  optional(:taxability_override) => String.t() | nil,
  optional(String.t()) => term()
}

address - The customer's postal address (for example, home or business location). Nullable.
address_source - The type of customer address provided. Possible values: billing, shipping. Nullable.
ip_address - The customer's IP address (IPv4 or IPv6). Max length: 5000. Nullable.
tax_ids - The customer's tax IDs (for example, EU VAT numbers).
taxability_override - The taxability override used for taxation. Possible values: customer_exempt, none, reverse_charge.

customer_details_address()

@type customer_details_address() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village. Max length: 5000. Nullable.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.
line2 - Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.
postal_code - ZIP or postal code. Max length: 5000. Nullable.
state - State/province as an ISO 3166-2 subdivision code, without country prefix, such as "NY" or "TX". Max length: 5000. Nullable.

customer_details_tax_ids()

@type customer_details_tax_ids() :: %{
  optional(:type) => String.t() | nil,
  optional(:value) => String.t() | nil,
  optional(String.t()) => term()
}

type - 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, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_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 Possible values: 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, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_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, 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.
value - The value of the tax ID. Max length: 5000.

line_items()

@type line_items() :: %{
  optional(:data) => [Stripe.Resources.Tax.TransactionLineItem.t()] | nil,
  optional(:has_more) => boolean() | nil,
  optional(:object) => String.t() | nil,
  optional(:url) => String.t() | nil,
  optional(String.t()) => term()
}

data - Details about each object.
has_more - True if this list has another page of items after this one that can be fetched.
object - String representing the object's type. Objects of the same type share the same value. Always has the value list. Possible values: list.
url - The URL where this list can be accessed. Max length: 5000.

reversal()

@type reversal() :: %{
  optional(:original_transaction) => String.t() | nil,
  optional(String.t()) => term()
}

original_transaction - The id of the reversed Transaction object. Max length: 5000. Nullable.

ship_from_details()

@type ship_from_details() :: %{
  optional(:address) => ship_from_details_address() | nil,
  optional(String.t()) => term()
}

address

ship_from_details_address()

@type ship_from_details_address() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village. Max length: 5000. Nullable.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Address line 1, such as the street, PO Box, or company name. Max length: 5000. Nullable.
line2 - Address line 2, such as the apartment, suite, unit, or building. Max length: 5000. Nullable.
postal_code - ZIP or postal code. Max length: 5000. Nullable.
state - State/province as an ISO 3166-2 subdivision code, without country prefix, such as "NY" or "TX". Max length: 5000. Nullable.

shipping_cost()

@type shipping_cost() :: %{
  optional(:amount) => integer() | nil,
  optional(:amount_tax) => integer() | nil,
  optional(:shipping_rate) => String.t() | nil,
  optional(:tax_behavior) => String.t() | nil,
  optional(:tax_breakdown) => [shipping_cost_tax_breakdown()] | nil,
  optional(:tax_code) => String.t() | nil,
  optional(String.t()) => term()
}

amount - The shipping amount in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount_tax - The amount of tax calculated for shipping, in the smallest currency unit.
shipping_rate - The ID of an existing ShippingRate. Max length: 5000.
tax_behavior - Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes. Possible values: exclusive, inclusive.
tax_breakdown - 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_code - The tax code ID used for shipping. Max length: 5000.

shipping_cost_tax_breakdown()

@type shipping_cost_tax_breakdown() :: %{
  optional(:amount) => integer() | nil,
  optional(:jurisdiction) => shipping_cost_tax_breakdown_jurisdiction() | nil,
  optional(:sourcing) => String.t() | nil,
  optional(:tax_rate_details) =>
    shipping_cost_tax_breakdown_tax_rate_details() | nil,
  optional(:taxability_reason) => String.t() | nil,
  optional(:taxable_amount) => integer() | nil,
  optional(String.t()) => term()
}

amount - The amount of tax, in the smallest currency unit.
jurisdiction
sourcing - Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). Possible values: destination, origin.
tax_rate_details - 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. Nullable.
taxability_reason - 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. Possible values: 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.
taxable_amount - The amount on which tax is calculated, in the smallest currency unit.

shipping_cost_tax_breakdown_jurisdiction()

@type shipping_cost_tax_breakdown_jurisdiction() :: %{
  optional(:country) => String.t() | nil,
  optional(:display_name) => String.t() | nil,
  optional(:level) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}

country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
display_name - A human-readable name for the jurisdiction imposing the tax. Max length: 5000.
level - Indicates the level of the jurisdiction imposing the tax. Possible values: city, country, county, district, state.
state - ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States. Max length: 5000. Nullable.

shipping_cost_tax_breakdown_tax_rate_details()

@type shipping_cost_tax_breakdown_tax_rate_details() :: %{
  optional(:display_name) => String.t() | nil,
  optional(:percentage_decimal) => String.t() | nil,
  optional(:tax_type) => String.t() | nil,
  optional(String.t()) => term()
}

display_name - 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.)". Max length: 5000.
percentage_decimal - The tax rate percentage as a string. For example, 8.5% is represented as "8.5". Max length: 5000.
tax_type - The tax type, such as vat or sales_tax. Possible values: amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, retail_delivery_fee, rst, sales_tax, service_tax, vat.

t()

@type t() :: %Stripe.Resources.Tax.Transaction{
  created: integer(),
  currency: String.t(),
  customer: String.t(),
  customer_details: customer_details(),
  id: String.t(),
  line_items: line_items() | nil,
  livemode: boolean(),
  metadata: %{required(String.t()) => String.t()},
  object: String.t(),
  posted_at: integer(),
  reference: String.t(),
  reversal: reversal(),
  ship_from_details: ship_from_details(),
  shipping_cost: shipping_cost(),
  tax_date: integer(),
  type: String.t()
}

created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
customer - The ID of an existing Customer used for the resource. Max length: 5000. Nullable.
customer_details - Expandable.
id - Unique identifier for the transaction. Max length: 5000.
line_items - The tax collected or refunded, by line item. Nullable. Expandable.
livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Nullable.
object - String representing the object's type. Objects of the same type share the same value. Possible values: tax.transaction.
posted_at - The Unix timestamp representing when the tax liability is assumed or reduced. Format: Unix timestamp.
reference - A custom unique identifier, such as 'myOrder_123'. Max length: 5000.
reversal - If type=reversal, contains information about what was reversed. Nullable. Expandable.
ship_from_details - The details of the ship from location, such as the address. Nullable. Expandable.
shipping_cost - The shipping cost details for the transaction. Nullable. Expandable.
tax_date - Timestamp of date at which the tax rules and rates in effect applies for the calculation. Format: Unix timestamp.
type - If reversal, this transaction reverses an earlier transaction. Possible values: reversal, transaction.