Tax Estimation
Transactions
Address Validation
Customers
Registrations
Products
Nexus
Get Transactions
The Get Transactions API retrieves a list of transactions with optional filtering, sorting, and pagination.
curl --request GET \
--url https://api.trykintsugi.com/v1/transactions \
--header 'X-API-KEY: <api-key>' \
--header 'x-organization-id: <api-key>'{
"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": "[email protected]",
"source": "SHOPIFY",
"connection_id": "conn_ABC123XYZ",
"address_status": "VERIFIED",
"id": "cust_987654321",
"organization_id": "orgn_123456789"
}
}
],
"total": 1,
"page": 1,
"size": 1,
"pages": 1
}Query Parameters
Filter transactions by state code.
Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).
Filter transactions based on the source.
Search for transactions using a general query (e.g., order ID, customer name).
Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).
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 Filter by full state name (e.g., California).
Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).
Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, ARCHIVED).
PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, INVALID, ARCHIVED Retrieve transactions linked to a specific filing ID.
Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).
Retrieve transactions with a date greater than or equal to (YYYY-MM-DD).
Retrieve transactions with a date less than or equal to (YYYY-MM-DD).
Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.
Filter transactions by marketplace (e.g., AMAZON, EBAY).
Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).
Page number
x >= 1Page size
1 <= x <= 100Response
Successfully retrieved transactions
Show child attributes
Show child attributes
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.
External identifier of the transaction.
Transaction date and time
The unique transaction identifier.
List of addresses associated.
Show child attributes
Show child attributes
Type of address. Allowed values: BILL_TO, SHIP_TO.
BILL_TO, SHIP_TO, SHIP_FROM, BILL_FROM Phone number associated with the address.
Primary street address.
Additional street address details, such as an apartment or suite number.
City where the customer resides.
County or district of the customer.
State or province of the customer.
ZIP or Postal code of the customer.
Country code in ISO 3166-1 alpha-2 format
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 Complete address string of the customer, which can be used as an alternative to individual fields.
Address verification status.** This field is ignored when updating addresses. The status of the address is updated automatically. **
UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE, BLANK Unique identifier of the address being updated.
ID of the transaction associated with the address.
ID of the connection associated with the address.
List of items in the transaction.
Show child attributes
Show child attributes
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.
Date/time of item.
External product identifier.
The unique transaction item identifier.
List of tax items associated with the transaction item.
Show child attributes
Show child attributes
Deprecated: use jurisdiction_type instead
250The rule ID of the tax item
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 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 IMPORTED_ORIGINAL, IMPORTED, CALCULATED 50COUNTRY, FEDERAL, STATE, COUNTY, CITY, SPECIAL, OTHER, HYBRID External item identifier.
Item description
Product name
Product identifier.
Product name (detailed)
Product description
Quantity of item.
Item amount.
Imported tax amount for the item.
Imported tax rate.
Calculated tax amount for the item.
Calculated tax rate.
Original currency code.
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 Destination currency code.
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 Converted item amount.
Converted taxable amount.
Converted imported tax amount.
Converted calculated tax amount
Converted total discount amount.
Converted subtotal amount.
Taxable amount for the item.
Tax exemption status.
PRODUCT, TRANSACTION, CUSTOMER, REGION, REVERSE_CHARGE, ZERO_RATE_TAX, HIGH_VALUE_PHYSICAL_GOODS, EXPORT, ZERO_VALUE_ITEM, NO_RULE_FOUND, IMPORTED Indicates if the item is exempt.
Total discount amount applied to this transaction item.
Subtotal amount before any discount is applied.
The type of transaction (e.g., SALE, REFUND, PARTIAL_CREDIT_NOTE).
SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, TAX_REFUND, ARCHIVE Indicates if transaction requires tax exemption.
Show child attributes
Show child attributes
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.
customer, wholesale, transaction ACTIVE, INACTIVE, EXPIRED, DEACTIVATED, ARCHIVED Transaction date in the shop's local timezone
Timezone of the shop
Description of the transaction.
Status of refund, if applicable
FULLY_REFUNDED, PARTIALLY_REFUNDED Total amount of the transaction.
Unique identifier of the customer.
Indicates if transaction is marketplace-based.
Exemption status (e.g., NOT_EXEMPT)
NOT_EXEMPT, PARTIALLY_EXEMPT, FULLY_EXEMPT List of exemptions applied (if any).
Show child attributes
Show child attributes
The type of exemption (e.g., wholesale, resale)
customer, wholesale, transaction Start date for the exemption validity period (YYYY-MM-DD format)
Unique identifier for the exemption
100Timestamp when transaction was created in Kintsugi.
Timestamp when transaction was last updated.
The jurisdiction identifier for the exemption
Country code in ISO 3166-1 alpha-2 format (e.g., 'US')
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 End date for the exemption validity period (YYYY-MM-DD format)
Unique identifier for the customer associated with the exemption
Unique identifier for the transaction associated with the exemption, if applicable.
Indicates whether the exemption is for a reseller
Federal Employer Identification Number associated with the exemption.
Sales tax ID for the exemption
The status of the exemption. Defaults to ACTIVE if not provided.
ACTIVE, INACTIVE, EXPIRED, DEACTIVATED, ARCHIVED 100Related transaction identifier.
Secondary External Identifier.
Secondary source information
Friendly identifier of the original item.
Imported tax amount.
Imported tax rate.
Calculated tax amount.
Calculated tax rate.
Total tax liability amount.
Source of tax liability.
CALCULATED, COLLECTED Taxable amount.
Currency code (ISO 4217, e.g., USD)
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 Transaction lock status.
Source platform (e.g., STRIPE)
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 Connection Identifier
Filing identifier.
City of the transaction address.
County of the transaction address.
State of the transaction address.
Country code (ISO Alpha-2).
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 Postal code of the transaction.
Tax ID associated with the transaction. DEPRECATED: This field is only populated for QuickBooks integrations and will be removed in a future version.
Transaction status (e.g., COMMITTED)
PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, INVALID, ARCHIVED Address verification status (e.g., VERIFIED).
UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE, BLANK Status of processing (e.g., ADDRESS_DONE)
NEW, UPDATED, QUEUED, ADDRESS_DONE, EXEMPT_DONE, NEXUS_DONE, PROCESSED, FILING_STARTED, FILING_DONE, LOCKED, PENDING, ARCHIVED, NEEDS_REFETCH Destination currency code (ISO 4217, e.g., USD)
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 Converted total amount.
Converted imported tax amount.
Converted calculated tax amount.
Currency conversion rate.
Converted taxable amount.
Converted total discount amount.
Converted subtotal amount.
Converted total tax liability amount.
Customer information associated with the transaction.
Show child attributes
Show child attributes
Unique identifier for the customer required.
Unique identifier for the organization associated with the customer. Required.
Customer's phone number
Primary street address.
Additional street address details, such as an apartment or suite number.
City where the customer resides.
County or district of the customer.
State or province of the customer.
ZIP or Postal code of the customer.
Country code in ISO 3166-1 alpha-2 format
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 Complete address string of the customer, which can be used as an alternative to individual fields.
Name of the customer.
External identifier associated with the customer.
Status of the customer.
ACTIVE, ARCHIVED Customer's email address
Source of the customer's record.
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 Identifier for the connection source, if applicable.
Status of address verification
UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE, BLANK Registration number of the customer.
External friendly identifier associated with the customer. We need it for netsuite.
Customer tax registrations associated with the customer.
Show child attributes
Show child attributes
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 Enum for customer tax registration types.
gst, hst, gst_hst, qst, pst, rst, vat, unknown Total amount of all discounts applied to the transaction.
Subtotal amount before any discounts are applied.
Final total amount including tax liability.
Converted final total amount including tax liability.
x >= 0x >= 1x >= 1x >= 0curl --request GET \
--url https://api.trykintsugi.com/v1/transactions \
--header 'X-API-KEY: <api-key>' \
--header 'x-organization-id: <api-key>'{
"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": "[email protected]",
"source": "SHOPIFY",
"connection_id": "conn_ABC123XYZ",
"address_status": "VERIFIED",
"id": "cust_987654321",
"organization_id": "orgn_123456789"
}
}
],
"total": 1,
"page": 1,
"size": 1,
"pages": 1
}