{
 "openapi": "3.1.0",
 "info": {
  "title": "Suppliers (Supply Chain)",
  "version": "20261030b",
  "description": "Open a supplier for its sites, financial terms, bank details, certifications, diversity and exclusions — the ordering address is almost never the one you pay."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "suppliers": {
    "type": "object",
    "required": [
     "supplier_no",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "supplier_no": {
      "type": "string",
      "description": "Supplier number"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "country": {
      "type": "string",
      "description": "Country"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "payment_terms_days": {
      "type": "integer",
      "description": "Payment terms (days)"
     },
     "contact_email": {
      "type": "string",
      "description": "Email"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "prospective",
       "approved",
       "hold",
       "inactive"
      ]
     },
     "quality_score": {
      "type": "string",
      "format": "decimal",
      "description": "Quality score"
     },
     "delivery_score": {
      "type": "string",
      "format": "decimal",
      "description": "Delivery score"
     },
     "risk_rating": {
      "type": "string",
      "description": "Risk rating"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "location_id": {
      "type": "string",
      "format": "uuid",
      "description": "Location id",
      "readOnly": true
     },
     "warehouse_id": {
      "type": "string",
      "format": "uuid",
      "description": "Warehouse id",
      "readOnly": true
     },
     "categories": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Registered for"
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "website": {
      "type": "string",
      "description": "Website"
     },
     "phone": {
      "type": "string",
      "description": "Main telephone"
     },
     "legal_name": {
      "type": "string",
      "description": "Legal name"
     },
     "industry": {
      "type": "string",
      "description": "Industry"
     },
     "address_line1": {
      "type": "string",
      "description": "Address line1"
     },
     "city": {
      "type": "string",
      "description": "City"
     },
     "region": {
      "type": "string",
      "description": "Region"
     },
     "postal_code": {
      "type": "string",
      "description": "Postal code"
     },
     "employee_count": {
      "type": "integer",
      "description": "Employees"
     },
     "founded_year": {
      "type": "integer",
      "description": "Founded (year)"
     },
     "description": {
      "type": "string",
      "description": "About the company"
     },
     "gstin": {
      "type": "string",
      "description": "Gstin",
      "readOnly": true
     },
     "pan": {
      "type": "string",
      "description": "Pan",
      "readOnly": true
     },
     "state_code": {
      "type": "string",
      "description": "State code",
      "readOnly": true
     },
     "gst_registration_type": {
      "type": "string",
      "description": "Gst registration type",
      "readOnly": true
     },
     "is_rcm_applicable": {
      "type": "boolean",
      "description": "Is rcm applicable",
      "readOnly": true
     },
     "tds_section": {
      "type": "string",
      "description": "Tds section",
      "readOnly": true
     },
     "inspect_on_receipt": {
      "type": "boolean",
      "description": "Inspect every delivery"
     },
     "merged_into_id": {
      "type": "string",
      "format": "uuid",
      "description": "Merged into id",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/scm/suppliers": {
   "get": {
    "summary": "list suppliers",
    "operationId": "list_suppliers_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create suppliers",
    "operationId": "create_suppliers_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/suppliers/{id}": {
   "get": {
    "summary": "get suppliers",
    "operationId": "get_suppliers_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change suppliers",
    "operationId": "change_suppliers_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete suppliers",
    "operationId": "delete_suppliers_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/suppliers/{id}/assess": {
   "post": {
    "summary": "Assess",
    "operationId": "action_suppliers_0_6",
    "description": "Body keys: period*, periodStart, periodEnd, qualityScore, serviceScore, complianceScore",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/suppliers/{id}/profile": {
   "get": {
    "summary": "Profile",
    "operationId": "action_suppliers_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/suppliers/{id}/usable": {
   "get": {
    "summary": "Usable",
    "operationId": "action_suppliers_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/suppliers/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_suppliers_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}