{
 "openapi": "3.1.0",
 "info": {
  "title": "Purchase Order Charges (Supply Chain)",
  "version": "20261030b",
  "description": "Every charge a purchase order carries: those worked out from the charge records (again whenever its lines change, until goods are received) and those added by hand. Billed charges are in the order’s total; accrued ones are what its receipt’s landed cost is estimated from."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "purchase-order-charges": {
    "type": "object",
    "required": [
     "document_type",
     "document_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "document_type": {
      "type": "string",
      "description": "Document type",
      "enum": [
       "Purchase order"
      ]
     },
     "document_id": {
      "type": "string",
      "format": "uuid",
      "description": "Purchase order"
     },
     "line_id": {
      "type": "string",
      "format": "uuid",
      "description": "Line"
     },
     "condition_type_id": {
      "type": "string",
      "format": "uuid",
      "description": "Condition type id"
     },
     "record_id": {
      "type": "string",
      "format": "uuid",
      "description": "Record id",
      "readOnly": true
     },
     "step_no": {
      "type": "integer",
      "description": "Step no",
      "readOnly": true
     },
     "charge_kind": {
      "type": "string",
      "description": "Kind of charge",
      "enum": [
       "Freight",
       "Insurance",
       "Packing and forwarding",
       "Inspection",
       "Customs duty",
       "Handling",
       "Other"
      ]
     },
     "charge_to": {
      "type": "string",
      "description": "Paid to",
      "enum": [
       "On this document (billed by the customer’s or supplier’s invoice)",
       "Accrued (paid to a carrier, customs or another party)"
      ]
     },
     "calc": {
      "type": "string",
      "description": "Calc",
      "readOnly": true
     },
     "rate": {
      "type": "string",
      "format": "decimal",
      "description": "Rate",
      "readOnly": true
     },
     "base_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Base amount",
      "readOnly": true
     },
     "amount": {
      "type": "string",
      "format": "decimal",
      "description": "Amount"
     },
     "is_statistical": {
      "type": "boolean",
      "description": "Shown but not added to the total"
     },
     "origin": {
      "type": "string",
      "description": "Origin",
      "readOnly": true
     },
     "description": {
      "type": "string",
      "description": "Description"
     },
     "amount_invoiced": {
      "type": "string",
      "format": "decimal",
      "description": "Amount invoiced",
      "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
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/scm/purchase-order-charges": {
   "get": {
    "summary": "list purchase-order-charges",
    "operationId": "list_purchase_order_charges_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create purchase-order-charges",
    "operationId": "create_purchase_order_charges_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/purchase-order-charges/{id}": {
   "get": {
    "summary": "get purchase-order-charges",
    "operationId": "get_purchase_order_charges_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change purchase-order-charges",
    "operationId": "change_purchase_order_charges_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete purchase-order-charges",
    "operationId": "delete_purchase_order_charges_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/purchase-order-charges/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_purchase_order_charges_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"
     }
    }
   }
  }
 }
}