Get Transactions

GET

transactions

Get Transactions

curl --request GET \
  --url https://api.trykintsugi.com/v1/transactions \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'

import requests

url = "https://api.trykintsugi.com/v1/transactions"

headers = {
    "X-API-KEY": "<api-key>",
    "x-organization-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-KEY': '<api-key>', 'x-organization-id': '<api-key>'}
};

fetch('https://api.trykintsugi.com/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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
}

{
  "detail": "The request is missing a valid x-api-key."
}

{
  "detail": "Entered an incorrect URL."
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "header",
        "x-organization-id"
      ],
      "msg": "Field required"
    }
  ]
}

{
  "detail": "An unexpected error occurred"
}

Authorizations

X-API-KEY

string

header

required

x-organization-id

string

header

required

Query Parameters

state_code

string

Filter transactions by state code.

transaction_type

string

Filter by transaction type (e.g., SALE, FULL_CREDIT_NOTE, PARTIAL_CREDIT_NOTE, ARCHIVE etc.).

transaction_source

string

Filter transactions based on the source.

search_query

string

Search for transactions using a general query (e.g., order ID, customer name).

country

enum<string>[]

Filter transactions by country code (ISO 3166-1 alpha-2 format, e.g., US).

Available options:

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

state

string

Filter by full state name (e.g., California).

address_status__in

string

default:UNVERIFIED,INVALID,PARTIALLY_VERIFIED,VERIFIED,UNVERIFIABLE

Filter by address status (e.g., UNVERIFIED, INVALID, PARTIALLY_VERIFIED, VERIFIED, UNVERIFIABLE).

status

enum<string>

Filter by transaction status (e.g., PENDING, COMMITTED, CANCELLED, FULLY_REFUNDED, PARTIALLY_REFUNDED, ARCHIVED).

Available options:

PENDING,

COMMITTED,

CANCELLED,

FULLY_REFUNDED,

PARTIALLY_REFUNDED,

INVALID,

ARCHIVED

filing_id

string

Retrieve transactions linked to a specific filing ID.

order_by

string

default:date,state,customer_name,status

Sort results based on specified fields. Prefix with - for descending order (e.g., -date for newest first).

date__gte

string

Retrieve transactions with a date greater than or equal to (YYYY-MM-DD).

date__lte

string

Retrieve transactions with a date less than or equal to (YYYY-MM-DD).

processing_status__in

string

Filter transactions based on processing status. Multiple values can be passed as a comma-separated list.

marketplace

boolean

Filter transactions by marketplace (e.g., AMAZON, EBAY).

exempt__in

string

Filter transactions by exemption status. Multiple values can be passed as a comma-separated list (e.g., EXEMPT,TAXABLE).

page

integer

default:1

Page number

Required range: x >= 1

size

integer

default:50

Page size

Required range: 1 <= x <= 100

Response

Successfully retrieved transactions

items

TransactionRead · object[]

required

Show child attributes

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

pages

integer

required

Required range: x >= 0

Get Transaction By IdThe Get Transaction By Id API retrieves detailed information about a specific transaction by providing its unique transaction ID.

⌘I

Get Transactions

curl --request GET \
  --url https://api.trykintsugi.com/v1/transactions \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'

import requests

url = "https://api.trykintsugi.com/v1/transactions"

headers = {
    "X-API-KEY": "<api-key>",
    "x-organization-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-KEY': '<api-key>', 'x-organization-id': '<api-key>'}
};

fetch('https://api.trykintsugi.com/v1/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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
}

{
  "detail": "The request is missing a valid x-api-key."
}

{
  "detail": "Entered an incorrect URL."
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "header",
        "x-organization-id"
      ],
      "msg": "Field required"
    }
  ]
}

{
  "detail": "An unexpected error occurred"
}

Tax Estimation

Transactions

Address Validation

Customers

Registrations

Products

Nexus

Filings

Exemptions

Authorizations

Query Parameters

Response