Lists deductions for the tenant with an exposure/recovery summary.

Deductions + summary

GET /v1/deductions

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/deductions' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

[
  {
    "adjustment_number": "string",
    "amount": "49.00",
    "category": "standard",
    "created_at": "2026-08-31T14:22:05Z",
    "currency": "USD",
    "evidence": [
      {
        "actor": "string",
        "at": "2026-08-31T14:22:05Z",
        "note": "Two-person tent, green — replacement for damaged pole set.",
        "url": "https://example.com/webhooks/stateset"
      }
    ],
    "history": [
      {
        "action": "string",
        "actor": "string",
        "at": "2026-08-31T14:22:05Z",
        "note": "Two-person tent, green — replacement for damaged pole set."
      }
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoice_number": "ORD-10042",
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reason_codes": [
      "string"
    ],
    "recovered_amount": "49.00",
    "status": "open",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated_at": "2026-08-31T14:22:05Z"
  }
]

Response

Deduction[] — each element:

adjustment_number · string · required

The 812 adjustment / chargeback number.

amount · string · required

category · string,null

Operator-assigned root-cause category (e.g. shortage, label, asn).

created_at · string (date-time) · required

currency · string

evidence · EvidenceNote[]

Supporting evidence attached for the dispute.

Show EvidenceNote

actor · string · required

at · string (date-time) · required

note · string · required

url · string,null

Link to the supporting artifact (an evidence-bundle export, a POD scan).

history · DeductionEvent[] · required

Show DeductionEvent

action · string · required

actor · string · required

at · string (date-time) · required

note · string,null

id · string · required

invoice_number · string,null

partner_id · string · required

reason_codes · string[]

recovered_amount · string,null

Amount recovered when disputed successfully (≤ amount).

status · DeductionStatus · required

Lifecycle state of a deduction. Allowed values: 'open', 'disputed', 'recovered', 'denied', 'written_off'.

tenant_id · string · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	Deductions + summary
403	Admin credential required

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/deductions' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

[
  {
    "adjustment_number": "string",
    "amount": "49.00",
    "category": "standard",
    "created_at": "2026-08-31T14:22:05Z",
    "currency": "USD",
    "evidence": [
      {
        "actor": "string",
        "at": "2026-08-31T14:22:05Z",
        "note": "Two-person tent, green — replacement for damaged pole set.",
        "url": "https://example.com/webhooks/stateset"
      }
    ],
    "history": [
      {
        "action": "string",
        "actor": "string",
        "at": "2026-08-31T14:22:05Z",
        "note": "Two-person tent, green — replacement for damaged pole set."
      }
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "invoice_number": "ORD-10042",
    "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reason_codes": [
      "string"
    ],
    "recovered_amount": "49.00",
    "status": "open",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated_at": "2026-08-31T14:22:05Z"
  }
]