{
 "openapi": "3.1.0",
 "info": {
  "title": "Supplier Sites (Supply Chain)",
  "version": "20261030b",
  "description": "One supplier, several places: where invoices come from (billing), where the goods leave from (shipping), where the payment goes and where orders are sent. Purposes are independent ticks because one address is very often several of them."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "supplier-sites": {
    "type": "object",
    "required": [
     "supplier_id",
     "site_no",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "supplier_id": {
      "type": "string",
      "format": "uuid",
      "description": "Supplier"
     },
     "site_no": {
      "type": "string",
      "description": "Site number"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "address_id": {
      "type": "string",
      "format": "uuid",
      "description": "Or choose from the address book"
     },
     "is_ordering": {
      "type": "boolean",
      "description": "Ordering address (orders are sent here)"
     },
     "is_ship_from": {
      "type": "boolean",
      "description": "Shipping / dispatch address (goods leave from here)"
     },
     "is_invoice_from": {
      "type": "boolean",
      "description": "Billing / invoicing address (invoices come from here)"
     },
     "is_payment": {
      "type": "boolean",
      "description": "Remit-to (payment goes here)"
     },
     "is_rfq": {
      "type": "boolean",
      "description": "RFQ address (quotations are sought here)"
     },
     "is_returns": {
      "type": "boolean",
      "description": "Returns address (rejected goods go back here)"
     },
     "is_primary": {
      "type": "boolean",
      "description": "Default for its purposes"
     },
     "buying_org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Buying org unit id"
     },
     "order_delivery": {
      "type": "string",
      "description": "Orders sent by",
      "enum": [
       "email",
       "edi",
       "portal",
       "post",
       "fax",
       "api",
       "none"
      ]
     },
     "order_email": {
      "type": "string",
      "description": "Order email"
     },
     "edi_identifier": {
      "type": "string",
      "description": "Edi identifier"
     },
     "customer_number_at_supplier": {
      "type": "string",
      "description": "Our account number with them"
     },
     "buyer_id": {
      "type": "string",
      "format": "uuid",
      "description": "Buyer id"
     },
     "incoterm": {
      "type": "string",
      "description": "Incoterm"
     },
     "incoterm_place": {
      "type": "string",
      "description": "Incoterm place"
     },
     "freight_terms": {
      "type": "string",
      "description": "Freight terms",
      "enum": [
       "prepaid",
       "collect",
       "prepaid_and_add",
       "third_party",
       "ex_works"
      ]
     },
     "ship_via": {
      "type": "string",
      "description": "Ship via"
     },
     "lead_time_days": {
      "type": "integer",
      "description": "Lead time (days)"
     },
     "country_of_origin": {
      "type": "string",
      "description": "Country of origin"
     },
     "port_of_loading": {
      "type": "string",
      "description": "Port of loading"
     },
     "invoice_currency": {
      "type": "string",
      "description": "Invoice currency"
     },
     "tax_registration_no": {
      "type": "string",
      "description": "Tax registration"
     },
     "invoice_country": {
      "type": "string",
      "description": "Invoices from country"
     },
     "contact_name": {
      "type": "string",
      "description": "Contact"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "active",
       "on_hold",
       "inactive",
       "pending_approval",
       "blocked"
      ]
     },
     "hold_reason": {
      "type": "string",
      "description": "Hold reason"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "effective_from": {
      "type": "string",
      "format": "date",
      "description": "In force from"
     },
     "effective_to": {
      "type": "string",
      "format": "date",
      "description": "Until"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "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_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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/scm/supplier-sites": {
   "get": {
    "summary": "list supplier-sites",
    "operationId": "list_supplier_sites_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create supplier-sites",
    "operationId": "create_supplier_sites_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/supplier-sites/{id}": {
   "get": {
    "summary": "get supplier-sites",
    "operationId": "get_supplier_sites_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change supplier-sites",
    "operationId": "change_supplier_sites_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete supplier-sites",
    "operationId": "delete_supplier_sites_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/supplier-sites/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_supplier_sites_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"
     }
    }
   }
  }
 }
}