> ## Documentation Index > Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Transactions > The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination. ## OpenAPI ````yaml get /v1/transactions openapi: 3.0.0 info: title: Tax Platform version: 1.0.0 servers: - url: https://api.trykintsugi.com description: Production API server URL security: [] paths: /v1/transactions: get: tags: - Transactions summary: Get Transactions description: |- The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination. operationId: get_transactions_v1_transactions_get parameters: - name: state_code in: query required: false schema: description: Filter transactions by state code. type: string description: Filter transactions by state code. - name: transaction_type in: query required: false schema: description: |- Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.). type: string description: |- Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.). - name: transaction_source in: query required: false schema: description: Filter transactions based on the source. type: string description: Filter transactions based on the source. - name: search_query in: query required: false schema: description: |- Search for transactions using a general query (e.g., order ID, customer name). type: string description: |- Search for transactions using a general query (e.g., order ID, customer name). - name: country in: query required: false schema: description: |- Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US). type: array items: $ref: '#/components/schemas/CountryCodeEnum' description: |- Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US). - name: state in: query required: false schema: description: Filter by full state name (e.g., California). type: string description: Filter by full state name (e.g., California). - name: address_status__in in: query required: false schema: description: |- Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE). default: UNVERIFIED,INVALID,PARTIALLY_VERIFIED,VERIFIED,UNVERIFIABLE type: string description: |- Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE). - name: status in: query required: false schema: $ref: '#/components/schemas/TransactionStatusEnum' description: |- Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, ARCHIVED). title: Status description: |- Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, ARCHIVED). - name: filing_id in: query required: false schema: description: Retrieve transactions linked to a specific filing ID. type: string description: Retrieve transactions linked to a specific filing ID. - name: order_by in: query required: false schema: description: |- Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first). default: date,state,customer_name,status type: string description: |- Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first). - name: date__gte in: query required: false schema: description: |- Retrieve transactions with a date greater than or equal to (YYYY-MM-DD). type: string description: |- Retrieve transactions with a date greater than or equal to (YYYY-MM-DD). - name: date__lte in: query required: false schema: description: |- Retrieve transactions with a date less than or equal to (YYYY-MM-DD). type: string description: |- Retrieve transactions with a date less than or equal to (YYYY-MM-DD). - name: processing_status__in in: query required: false schema: description: |- Filter transactions based on processing status. Multiple values can be passed as a comma-separated list. type: string description: |- Filter transactions based on processing status. Multiple values can be passed as a comma-separated list. - name: marketplace in: query required: false schema: description: Filter transactions by marketplace (e.g., AMAZON, EBAY). type: boolean description: Filter transactions by marketplace (e.g., AMAZON, EBAY). - name: exempt__in in: query required: false schema: description: |- Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE). type: string description: |- Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE). - name: page in: query required: false schema: type: integer minimum: 1 description: Page number default: 1 title: Page description: Page number - name: size in: query required: false schema: type: integer maximum: 100 minimum: 1 description: Page size default: 50 title: Size description: Page size responses: '200': description: Successfully retrieved transactions content: application/json: schema: $ref: '#/components/schemas/Page_TransactionRead_' example: items: - organization_id: orgn_123456789 external_id: TXN-001 date: '2025-03-01T10:30:00' status: COMMITTED description: 'Order #001 from Example Store' processing_status: ADDRESS_DONE total_amount: '250.00' customer_id: cust_987654321 marketplace: false exempt: NOT_EXEMPT exemptions: [] secondary_external_id: Example Store secondary_source: SHOPIFY total_tax_amount_imported: '15.00' tax_rate_imported: '0.06' total_tax_amount_calculated: '15.00' tax_rate_calculated: '0.06' taxable_amount: '250.00' currency: USD locked: false source: OTHER connection_id: conn_ABC123XYZ filing_id: file_1234567 destination_currency: USD converted_total_amount: 1000 converted_total_tax_amount_imported: 1200 converted_total_tax_amount_calculated: 1200 conversion_rate: 1 city: Los Angeles county: Los Angeles County state: CA country: US postal_code: '90001' address_status: VERIFIED id: tran_001ABCDEF type: SALE total_discount: '0.00' subtotal: '250.00' addresses: - phone: '1234567890' street_1: 123 Main St street_2: Apt 4B city: Los Angeles county: Los Angeles County state: CA postal_code: '90001' country: US full_address: 123 Main St, Apt 4B, Los Angeles, CA, 90001, US type: BILL_TO status: VERIFIED id: addr_123XYZ transaction_id: tran_001ABCDEF - phone: '9876543210' street_1: 456 Elm St street_2: '' city: San Francisco county: San Francisco County state: CA postal_code: '94102' country: US full_address: 456 Elm St, San Francisco, CA, 94102, US type: SHIP_TO status: VERIFIED id: addr_456XYZ transaction_id: tran_001ABCDEF transaction_items: - external_id: ITEM-001 organization_id: orgn_123456789 date: '2025-03-01T10:30:00' description: Blue T-Shirt external_product_id: P001 product: Blue T-Shirt product_id: prod_ABC123 product_name: Blue T-Shirt - Large product_description: A stylish blue t-shirt, size Large quantity: '2' amount: '50.00' tax_amount_imported: '3.00' tax_rate_imported: '0.06' tax_amount_calculated: '3.00' tax_rate_calculated: '0.06' taxable_amount: '50.00' exempt: false id: txim_ABCDEF123 tax_items: - rule_id: '0000' rate: '0.00' amount: '0.00' converted_amount: '0.00' currency: USD destination_currency: USD external_id: ext_1234 name: product type: IMPORTED jurisdiction_type: COUNTRY jurisdiction_name: CA total_discount: '0.00' subtotal: '100.00' - external_id: ITEM-002 organization_id: orgn_123456789 date: '2025-03-01T10:30:00' description: Wireless Headphones external_product_id: P002 product: Wireless Headphones product_id: prod_DEF456 product_name: Noise-Cancelling Wireless Headphones product_description: >- High-quality wireless headphones with noise cancellation quantity: '1' amount: '150.00' tax_amount_imported: '9.00' tax_rate_imported: '0.06' tax_amount_calculated: '9.00' tax_rate_calculated: '0.06' taxable_amount: '150.00' exempt: false id: txim_DEF456 tax_items: [] total_discount: '0.00' subtotal: '150.00' customer: phone: '1234567890' street_1: 123 Main St street_2: Apt 4B city: Los Angeles county: Los Angeles County state: CA postal_code: '90001' country: US full_address: 123 Main St, Apt 4B, Los Angeles, CA, 90001, US name: John Doe external_id: CUST-001 status: ACTIVE email: johndoe@example.com source: SHOPIFY connection_id: conn_ABC123XYZ address_status: VERIFIED id: cust_987654321 organization_id: orgn_123456789 total: 1 page: 1 size: 1 pages: 1 '401': description: Unauthenticated request. content: application/json: example: detail: The request is missing a valid x-api-key. schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Resource not found content: application/json: example: detail: Entered an incorrect URL. schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation error content: application/json: example: detail: - type: missing loc: - header - x-organization-id msg: Field required schema: $ref: >- #/components/schemas/backend__src__transactions__responses__ValidationErrorResponse '500': description: Internal server error content: application/json: example: detail: An unexpected error occurred schema: $ref: '#/components/schemas/ErrorResponse' security: - APIKeyHeader: [] CustomHeader: [] components: schemas: CountryCodeEnum: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - CI - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - XK - ZZ_EU title: CountryCodeEnum TransactionStatusEnum: type: string enum: - PENDING - COMMITTED - CANCELLED - FULLY_REFUNDED - PARTIALLY_REFUNDED - INVALID - ARCHIVED title: TransactionStatusEnum Page_TransactionRead_: properties: items: items: $ref: '#/components/schemas/TransactionRead' type: array title: Items total: type: integer minimum: 0 title: Total page: type: integer minimum: 1 title: Page size: type: integer minimum: 1 title: Size pages: type: integer minimum: 0 title: Pages type: object required: - items - total - page - size - pages title: Page[TransactionRead] ErrorResponse: properties: detail: type: string title: Detail description: Error message type: object required: - detail title: ErrorResponse backend__src__transactions__responses__ValidationErrorResponse: properties: detail: items: $ref: >- #/components/schemas/backend__src__transactions__responses__ValidationErrorItem type: array title: Detail type: object required: - detail title: ValidationErrorResponse TransactionRead: properties: requires_exemption: $ref: '#/components/schemas/ExemptionRequired' description: Indicates if transaction requires tax exemption. organization_id: type: string title: Organization Id description: >- Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header. deprecated: true external_id: type: string minLength: 1 title: External Id description: External identifier of the transaction. date: type: string format: date-time title: Date description: Transaction date and time shop_date: description: Transaction date in the shop's local timezone type: string shop_date_tz: description: Timezone of the shop type: string description: description: Description of the transaction. type: string refund_status: $ref: '#/components/schemas/TransactionRefundStatus' description: Status of refund, if applicable total_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total Amount description: Total amount of the transaction. default: '0.00' customer_id: description: Unique identifier of the customer. type: string marketplace: description: Indicates if transaction is marketplace-based. default: false type: boolean exempt: $ref: '#/components/schemas/TransactionExemptStatusEnum' description: Exemption status (e.g., NOT_EXEMPT) default: NOT_EXEMPT exemptions: description: List of exemptions applied (if any). type: array items: $ref: '#/components/schemas/Exemption' related_to: description: Related transaction identifier. type: string secondary_external_id: description: Secondary External Identifier. type: string secondary_source: description: Secondary source information type: string external_friendly_id: description: Friendly identifier of the original item. type: string total_tax_amount_imported: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total Tax Amount Imported description: Imported tax amount. default: '0.00' tax_rate_imported: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Tax Rate Imported description: Imported tax rate. default: '0.00' total_tax_amount_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total Tax Amount Calculated description: Calculated tax amount. default: '0.00' tax_rate_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Tax Rate Calculated description: Calculated tax rate. default: '0.00' total_tax_liability_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Total Tax Liability Amount description: Total tax liability amount. default: '0.00' tax_liability_source: $ref: '#/components/schemas/TaxLiabilitySourceEnum' description: Source of tax liability. taxable_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Taxable Amount description: Taxable amount. default: '0.00' currency: $ref: '#/components/schemas/CurrencyEnum' description: Currency code (ISO 4217, e.g., USD) default: USD locked: type: boolean title: Locked description: Transaction lock status. default: false source: $ref: '#/components/schemas/SourceEnum' description: Source platform (e.g., STRIPE) default: OTHER connection_id: description: Connection Identifier type: string filing_id: description: Filing identifier. type: string city: description: City of the transaction address. type: string county: description: County of the transaction address. type: string state: description: State of the transaction address. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code (ISO Alpha-2). postal_code: description: Postal code of the transaction. type: string tax_id: description: >- Tax ID associated with the transaction. DEPRECATED: This field is only populated for QuickBooks integrations and will be removed in a future version. deprecated: true type: string status: $ref: '#/components/schemas/TransactionStatusEnum' description: Transaction status (e.g., COMMITTED) default: COMMITTED address_status: $ref: '#/components/schemas/AddressStatus' description: Address verification status (e.g., VERIFIED). default: UNVERIFIED processing_status: $ref: '#/components/schemas/ProcessingStatusEnum' description: Status of processing (e.g., ADDRESS_DONE) default: QUEUED destination_currency: $ref: '#/components/schemas/CurrencyEnum' description: Destination currency code (ISO 4217, e.g., USD) converted_total_amount: description: Converted total amount. type: string converted_total_tax_amount_imported: description: Converted imported tax amount. type: string converted_total_tax_amount_calculated: description: Converted calculated tax amount. type: string conversion_rate: description: Currency conversion rate. type: string converted_taxable_amount: description: Converted taxable amount. type: string converted_total_discount: description: Converted total discount amount. type: string converted_subtotal: description: Converted subtotal amount. type: string converted_total_tax_liability_amount: description: Converted total tax liability amount. type: string id: type: string title: Id description: The unique transaction identifier. addresses: items: $ref: '#/components/schemas/TransactionAddressRead-Output' type: array title: Addresses description: List of addresses associated. transaction_items: items: $ref: '#/components/schemas/TransactionItemRead' type: array title: Transaction Items description: List of items in the transaction. customer: $ref: '#/components/schemas/CustomerRead' description: Customer information associated with the transaction. type: $ref: '#/components/schemas/TransactionTypeEnum' description: |- The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE). total_discount: description: Total amount of all discounts applied to the transaction. type: string subtotal: description: Subtotal amount before any discounts are applied. type: string final_total_amount: description: Final total amount including tax liability. type: string converted_final_total_amount: description: Converted final total amount including tax liability. type: string type: object required: - organization_id - external_id - date - id - addresses - transaction_items - type title: TransactionRead backend__src__transactions__responses__ValidationErrorItem: properties: type: type: string title: Type description: |- Validation issues, such as missing required fields or invalid field values. loc: items: type: string type: array title: Loc description: Location of error msg: type: string title: Msg description: Error message input: title: Input description: Invalid input value ctx: additionalProperties: true type: object title: Ctx description: Additional context type: object required: - type - loc - msg - input - ctx title: ValidationErrorItem ExemptionRequired: properties: jurisdiction: type: string customer_id: type: string organization_id: type: string title: Organization Id description: >- Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header. deprecated: true exemption_type: $ref: '#/components/schemas/ExemptionType' start_date: type: string format: date-time title: Start Date status: $ref: '#/components/schemas/ExemptionStatus' reseller: type: boolean title: Reseller type: object required: - organization_id - exemption_type - start_date - status - reseller title: ExemptionRequired TransactionRefundStatus: type: string enum: - FULLY_REFUNDED - PARTIALLY_REFUNDED title: TransactionRefundStatus description: >- Shopify has 2 order statuses for refund case: refunded and partially_refunded If the given order has different status from these 2, we will set the transaction's refund_status to PARTIALLY_REFUNDED by default. TransactionExemptStatusEnum: type: string enum: - NOT_EXEMPT - PARTIALLY_EXEMPT - FULLY_EXEMPT - ZERO_RATE_NOT_EXEMPT title: TransactionExemptStatusEnum description: |- Based on transaction item exempt status. NOT EXEMPT: None of the items are NOT EXEMPT PARTIALLY EXEMPT: At least some of the items are NOT EXEMPT FULLY_EXEMPT: All items sold in the transaction are EXEMPT ZERO_RATE_NOT_EXEMPT: All items sold in the transaction are zero-rated Exemption: properties: id: type: string maxLength: 100 title: Id description: Unique identifier for the exemption created_at: type: string format: date-time title: Created At description: Timestamp when transaction was created in Kintsugi. updated_at: description: Timestamp when transaction was last updated. type: string exemption_type: $ref: '#/components/schemas/ExemptionType' description: The type of exemption (e.g., wholesale, resale) jurisdiction: description: The jurisdiction identifier for the exemption type: string country_code: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format (e.g., 'US') start_date: type: string format: date title: Start Date description: Start date for the exemption validity period (YYYY-MM-DD format) end_date: description: End date for the exemption validity period (YYYY-MM-DD format) type: string customer_id: description: Unique identifier for the customer associated with the exemption type: string transaction_id: description: |- Unique identifier for the transaction associated with the exemption, if applicable. type: string reseller: type: boolean title: Reseller description: Indicates whether the exemption is for a reseller default: false FEIN: description: |- Federal Employer Identification Number associated with the exemption. type: string sales_tax_id: description: Sales tax ID for the exemption type: string status: $ref: '#/components/schemas/ExemptionStatus' description: |- The status of the exemption. Defaults to ACTIVE if not provided. organization_id: type: string maxLength: 100 title: Organization Id type: object required: - exemption_type - start_date title: Exemption TaxLiabilitySourceEnum: type: string enum: - CALCULATED - COLLECTED title: TaxLiabilitySourceEnum CurrencyEnum: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GGP - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IMP - INR - IQD - IRR - ISK - JEP - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SPL - SRD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TVD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XDR - XOF - XPF - YER - ZAR - ZMW - ZWD title: CurrencyEnum SourceEnum: type: string enum: - BIGCOMMERCE - BESTBUY - BUNNY - CHARGEBEE - SHOPIFY - STRIPE - AMAZON - TIKTOK - CUSTOM - UNKNOWN - IMPORT - ZUORA - APIDECK - QUICKBOOKS - API - APPLE_APP_STORE - GOOGLE_APP_STORE - WALMART - PAYPAL - NETSUITE - XERO - MAXIO - RECURLY - SALESFORCE - ETSY - EBAY - WIX - SQUARESPACE - WOOCOMMERCE - MAGENTO - BILLING_PLATFORM - DEEL - RIPPLING - GUSTO - FACEBOOK - OTHER - ORDWAY - INSTAGRAM - PINTEREST - WAYFAIR - WISH - POS - TARGET - NEWEGG - GROUPON - GOOGLE_EXPRESS - NOCNOC - MERCADO_LIBRE - MODALYST - NORDSTROM - FAIRE - SHOPWARE - ZOHO - SAGE-INTACCT - AIRWALLEX - ORB - ZENSKAR - MICROSOFT_DYNAMICS_365 - KICKSTARTER - INTERNAL_ERP title: SourceEnum AddressStatus: type: string enum: - UNVERIFIED - INVALID - PARTIALLY_VERIFIED - VERIFIED - UNVERIFIABLE - BLANK title: AddressStatus ProcessingStatusEnum: type: string enum: - NEW - UPDATED - QUEUED - ADDRESS_DONE - EXEMPT_DONE - NEXUS_DONE - PROCESSED - FILING_STARTED - FILING_DONE - LOCKED - PENDING - ARCHIVED - NEEDS_REFETCH - EXCLUDED_IN_CALCULATION title: ProcessingStatusEnum description: >- Our transaction state, used to determine when/if a transaction needs additional processing. TransactionAddressRead-Output: properties: phone: description: Phone number associated with the address. type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string type: $ref: '#/components/schemas/AddressType' description: 'Type of address. Allowed values: BILL_TO, SHIP_TO.' status: $ref: '#/components/schemas/AddressStatus' description: >- Address verification status.** This field is ignored when updating addresses. The status of the address is updated automatically. ** default: UNVERIFIED id: description: Unique identifier of the address being updated. type: string transaction_id: description: ID of the transaction associated with the address. type: string connection_id: description: ID of the connection associated with the address. type: string type: object required: - type title: TransactionAddressRead TransactionItemRead: properties: external_id: description: External item identifier. type: string organization_id: description: >- Unique identifier of the organization. This field is deprecated, and should no longer be used. The value is populated through the 'x-organization-id' header. deprecated: true type: string date: type: string format: date-time title: Date description: Date/time of item. description: description: Item description type: string external_product_id: type: string title: External Product Id description: External product identifier. product: description: Product name type: string product_id: description: Product identifier. type: string product_name: description: Product name (detailed) type: string product_description: description: Product description type: string quantity: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,20}|(?=[\d.]{1,41}0*$)\d{0,20}\.\d{0,20}0*$) title: Quantity description: Quantity of item. default: '1.0' amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Amount description: Item amount. default: '0.00' tax_amount_imported: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Tax Amount Imported description: Imported tax amount for the item. default: '0.00' tax_rate_imported: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Tax Rate Imported description: Imported tax rate. default: '0.00' tax_amount_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Tax Amount Calculated description: Calculated tax amount for the item. default: '0.00' tax_rate_calculated: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Tax Rate Calculated description: Calculated tax rate. default: '0.00' original_currency: $ref: '#/components/schemas/CurrencyEnum' description: Original currency code. destination_currency: $ref: '#/components/schemas/CurrencyEnum' description: Destination currency code. converted_amount: description: Converted item amount. type: string converted_taxable_amount: description: Converted taxable amount. type: string converted_tax_amount_imported: description: Converted imported tax amount. type: string converted_tax_amount_calculated: description: Converted calculated tax amount type: string converted_total_discount: description: Converted total discount amount. type: string converted_subtotal: description: Converted subtotal amount. type: string taxable_amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Taxable Amount description: Taxable amount for the item. default: '0.00' tax_exemption: $ref: '#/components/schemas/TaxExemptionEnum' description: Tax exemption status. exempt: type: boolean title: Exempt description: Indicates if the item is exempt. default: false id: type: string title: Id description: The unique transaction item identifier. tax_items: items: $ref: '#/components/schemas/TaxItemRead' type: array title: Tax Items description: List of tax items associated with the transaction item. total_discount: description: Total discount amount applied to this transaction item. type: string subtotal: description: Subtotal amount before any discount is applied. type: string type: object required: - organization_id - date - external_product_id - id - tax_items title: TransactionItemRead CustomerRead: properties: phone: description: Customer's phone number type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string name: description: Name of the customer. type: string external_id: description: External identifier associated with the customer. type: string status: $ref: '#/components/schemas/StatusEnum' description: Status of the customer. default: ACTIVE email: description: Customer's email address type: string source: $ref: '#/components/schemas/SourceEnum' description: Source of the customer's record. connection_id: description: Identifier for the connection source, if applicable. type: string address_status: $ref: '#/components/schemas/AddressStatus' description: Status of address verification default: UNVERIFIED registration_number: description: Registration number of the customer. type: string external_friendly_id: description: >- External friendly identifier associated with the customer. We need it for netsuite. type: string customer_tax_registrations: items: $ref: '#/components/schemas/CustomerTaxRegistrationRead' type: array title: Customer Tax Registrations description: Customer tax registrations associated with the customer. id: type: string title: Id description: Unique identifier for the customer required. organization_id: type: string title: Organization Id description: >- Unique identifier for the organization associated with the customer. Required. type: object required: - id - organization_id title: CustomerRead TransactionTypeEnum: type: string enum: - SALE - FULL_CREDIT_NOTE - PARTIAL_CREDIT_NOTE - TAX_REFUND - ARCHIVE title: TransactionTypeEnum ExemptionType: type: string enum: - customer - wholesale - transaction title: ExemptionType ExemptionStatus: type: string enum: - ACTIVE - INACTIVE - EXPIRED - DEACTIVATED - ARCHIVED title: ExemptionStatus AddressType: type: string enum: - BILL_TO - SHIP_TO - SHIP_FROM - BILL_FROM title: AddressType TaxExemptionEnum: type: string enum: - PRODUCT - TRANSACTION - CUSTOMER - REGION - REVERSE_CHARGE - ZERO_RATE_TAX - HIGH_VALUE_PHYSICAL_GOODS - EXPORT - ZERO_VALUE_ITEM - NO_RULE_FOUND - IMPORTED - ZERO_RATE_NOT_EXEMPT title: TaxExemptionEnum description: This enum is used to determine if a transaction is exempt from tax. TaxItemRead: properties: rule_id: type: string title: Rule Id description: The rule ID of the tax item default: '0000' rate: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,13}0*$)\d{0,3}\.\d{0,9}0*$) title: Rate amount: type: string pattern: >- ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$) title: Amount converted_amount: type: string currency: $ref: '#/components/schemas/CurrencyEnum' destination_currency: $ref: '#/components/schemas/CurrencyEnum' external_id: type: string name: type: string maxLength: 250 title: Name description: 'Deprecated: use `jurisdiction_type` instead' type: $ref: '#/components/schemas/TaxItemTypeEnum' maxLength: 50 default: IMPORTED jurisdiction_type: $ref: '#/components/schemas/JurisdictionType' jurisdiction_name: type: string type: object required: - rate - amount - name title: TaxItemRead StatusEnum: type: string enum: - ACTIVE - ARCHIVED title: StatusEnum CustomerTaxRegistrationRead: properties: id: type: string title: Id customer_id: type: string title: Customer Id country_code: $ref: '#/components/schemas/CountryCodeEnum' tax_type: $ref: '#/components/schemas/CustomerTaxTypeEnum' tax_id: type: string title: Tax Id is_valid: type: boolean title: Is Valid type: object required: - id - customer_id - country_code - tax_type - tax_id - is_valid title: CustomerTaxRegistrationRead TaxItemTypeEnum: type: string enum: - IMPORTED_ORIGINAL - IMPORTED - CALCULATED title: TaxItemTypeEnum JurisdictionType: type: string enum: - COUNTRY - FEDERAL - STATE - COUNTY - CITY - SPECIAL - OTHER - HYBRID title: JurisdictionType CustomerTaxTypeEnum: type: string enum: - gst - hst - gst_hst - qst - pst - rst - vat - unknown title: CustomerTaxTypeEnum description: Enum for customer tax registration types. securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-KEY CustomHeader: type: apiKey in: header name: x-organization-id ````