{
 "openapi": "3.1.0",
 "info": {
  "title": "Profitability Derivation Rules (Accounting)",
  "version": "20261030b",
  "description": "What fills in the characteristics the documents do not carry — a sales region derived from the customer’s country being the usual case."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "pa-derivation-rules": {
    "type": "object",
    "required": [
     "code",
     "name",
     "characteristic_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "priority": {
      "type": "integer",
      "description": "Priority"
     },
     "characteristic_id": {
      "type": "string",
      "format": "uuid",
      "description": "Sets characteristic"
     },
     "source_characteristic_id": {
      "type": "string",
      "format": "uuid",
      "description": "From characteristic"
     },
     "match_value": {
      "type": "string",
      "description": "When the source is"
     },
     "match_pattern": {
      "type": "string",
      "description": "Or matches pattern"
     },
     "item_group": {
      "type": "string",
      "description": "Item group"
     },
     "account_type": {
      "type": "string",
      "description": "Account type"
     },
     "country": {
      "type": "string",
      "description": "And the country is"
     },
     "derived_value": {
      "type": "string",
      "description": "Set it to"
     },
     "derivation": {
      "type": "string",
      "description": "How",
      "enum": [
       "constant",
       "lookup",
       "table",
       "expression",
       "inherit"
      ]
     },
     "lookup_table": {
      "type": "string",
      "description": "Lookup table"
     },
     "lookup_field": {
      "type": "string",
      "description": "Lookup field"
     },
     "expression": {
      "type": "string",
      "description": "Expression"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/pa-derivation-rules": {
   "get": {
    "summary": "list pa-derivation-rules",
    "operationId": "list_pa_derivation_rules_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create pa-derivation-rules",
    "operationId": "create_pa_derivation_rules_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/pa-derivation-rules/{id}": {
   "get": {
    "summary": "get pa-derivation-rules",
    "operationId": "get_pa_derivation_rules_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change pa-derivation-rules",
    "operationId": "change_pa_derivation_rules_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete pa-derivation-rules",
    "operationId": "delete_pa_derivation_rules_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/pa-derivation-rules/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_pa_derivation_rules_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"
     }
    }
   }
  }
 }
}