Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kintsugi Transactions API

Committed sales transactions and credit notes.

Kintsugi Transactions API is one of 9 APIs that Kintsugi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.trykintsugi.com/v1.

7 operations 4 paths 8 schemas 3 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.trykintsugi.com/v1
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Kintsugi Transactions API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). An API key is passed in the header as x-organization-id (OrganizationId). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated in the Kintsugi dashboard.
  • OrganizationId — Identifier of the organization the request acts on behalf of.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Transactions 7

Committed sales transactions and credit notes.

POST
/transactions
Create a transaction.
createTransaction body → 201401422
GET
/transactions
List transactions.
getTransactions 2 params → 200401
GET
/transactions/{id}
Get a transaction by ID.
getTransactionById 1 param → 200404
PATCH
/transactions/{id}
Update a transaction.
updateTransaction 1 param body → 200404
GET
/transactions/external/{external_id}
Get a transaction by external ID.
getTransactionByExternalId 1 param → 200404
POST
/transactions/{id}/credit-notes
Create a credit note for a transaction.
createCreditNoteByTransactionId 1 param body → 201
PATCH
/transactions/{id}/credit-notes
Update a credit note for a transaction.
updateCreditNoteByTransactionId 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TransactionItemEstimate (9 properties), Address (9 properties), TransactionRequest (7 properties), Page (5 properties). Each schema is shown below with its type and property counts.

TransactionItemEstimate
object
9 properties 2 required
Address
object
9 properties 2 required
CreditNoteRequest
object
4 properties
Transaction
TransactionPage
Page
object
5 properties
TransactionRequest
object
7 properties 3 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kintsugi-transactions-api-openapi.yml Raw ↑

Other APIs Kintsugi publishes across the network.

Kintsugi Address Validation API
Kintsugi Customers API
Kintsugi Exemptions API
Kintsugi Filings API
Kintsugi Nexus API
Kintsugi Products API
Kintsugi Registrations API
Kintsugi Tax Estimation API