# 6. External Write APIs There are totally 【84】 external write APIs exposed by the system, which collectively encompass nearly all legal acts relating to corporate governance, share transactions, and the payment and receipt of USDC. These APIs are routed to various Sub-Keepers for further processing and execution, thereby effectuating the corresponding legal consequences of each act.
6.1. APIs Routed to ROC Keeper
S.N.APIDescription of Functions and Input Parameters
01function createSHA(
uint version
) external		(Any Member) Create a new shareholders agreement by cloning the Template of the specific version.
02

Function circulateSHA(

address body,

bytes32 docUrl,

bytes32 docHash

) external

(The Owner of the draft) Circulate the finalized draft of shareholders agreement deployed at the address of body to the contractual parties for signing, with the URL infomation of docUrl, and hash value of docHash.
03

function signSHA(

address sha,

bytes32 sigHash

) external

(Parties to the draft) Sign the finalized draft of shareholders agreement deployed at the address of sha, with the hash value of signature as sigHash.
04

function activateSHA(

address body

) external

(Any user) Activate the draft of shareholders agreement deployed at the address of body.
05

function acceptSHA(

bytes32 sigHash

) external

(Any user) Accept the terms and conditons of SHA in force, with the hash value as sigHash.
6.2. APIs Routed to ROD Keeper
S.N.APIDescription of Functions and Input Parameters
06

function takeSeat(

uint256 seqOfMotion,

uint256 seqOfPos

) external

(The elected Director) Assume the director’s seat identified by seqOfPos pursuant to the authorization granted under the Motion identified by seqOfMotion.
07

function removeDirector (

uint256 seqOfMotion,

uint256 seqOfPos

) external

(The Member having the nomination right) Remove the director on the position numbered as seqOfPos as per the removal Motion numbered as seqOfMotion.
08

function takePosition(

uint256 seqOfMotion,

uint256 seqOfPos

) external

(The elected officer) Take the officer position identified as seqOfPos pursuant to the authorization granted under the Motion identified as seqOfMotion.
09

function removeOfficer (

uint256 seqOfMotion,

uint256 seqOfPos

) external

(The executor) Remove the executive officer on the position numbered as seqOfPos as per the removal Motion numbered as seqOfMotion.
10

function quitPosition(

uint256 seqOfPos

) external

(The Director or officer) Quit the position identified as seqOfPos voluntarily.
6.3. APIs Routed to BMM Keeper
S.N.APIDescription of Functions and Input Parameters
11

function nominateOfficer(

uint256 seqOfPos,

uint256 candidate

) external

(The Director having the nomination right) Nominate the user identified by its user number as candidate for the officer’s position numbered as seqOfPos.
12

function createMotionToRemoveOfficer(

uint256 seqOfPos

) external

(The Director having the nomination right) Create a draft Motion to remove the officer on the position numbered as seqOfPos.
13

function createMotionToApproveDoc(

uint256 doc,

uint256 seqOfVR,

uint256 executor

) external

(Any Director) Creates a draft Motion for the Board to approve the document deployed at the address of doc as per the voting rule numbered as seqOfVR with the user numbered as executor to invoke it.
14

function proposeToTransferFundWithBoard(

address to,

bool isCBP,

uint256 amt,

uint256 expireDate,

uint256 seqOfVR,

uint256 executor

) external

(Any Director) Propose, to the Board Meeting, to transfer certain amount of CBP (isCBP is true) or USDC (isCBP is false), to the account address to, amount to amt, before the timestamp of expireDate, as per the Voting Rule numbered as seqOfVR, with the user numbered as executor to execute the Motion concerned.
15

function createAction(

uint256 seqOfVR,

address[] memory targets,

uint256[] memory values,

bytes[] memory params,

bytes32 desHash,

uint256 executor

) external

Create a draft Motion for the Board to invoke a series of calls, as per the voting rule numbered as seqOfVR, to the contracts deployed at their respective addresses of targets, with paying ETH amount to values, and inputting parameters of params, attached with the hash value of the description message as desHash, with the user numbered as executor to invoke it.
16

function entrustDelegaterForBoardMeeting(

uint256 seqOfMotion,

uint256 delegate

) external

(Any Directors) Entrust the user numbered as delegate to cast vote in Board meeting for the Motion identified as seqOfMotion.
17

function proposeMotionToBoard (

uint256 seqOfMotion

) external

(Any Director) Propose the draft Motion numbered as seqOfMotion to the Board meeting.
18

function castVote(

uint256 seqOfMotion,

uint256 attitude,

bytes32 sigHash

) external

(Any Director) Casts vote with the attitude for the Motion numbered as seqOfMotion with the signature message’s hash value as sigHash.
19

function voteCounting(

uint256 seqOfMotion

) external

(Any user) Count the vote result for the Motion numbered as seqOfMotion.
20

function execAction(

uint typeOfAction,

address[] memory targets,

uint256[] memory values,

bytes[] memory params,

bytes32 desHash,

uint256 seqOfMotion

) external

(The designated executor) Executes the Motion numbered as seqOfMotion, categorized as typeOfAction, to invoke the series of calls to the contracts deployed at addresses of targets, with paying the respective ETH amount to values, inputting parameters as params, attached with description message’s hash value as desHash.
6.4. APIs Routed to ROM Keeper
S.N.APIDescription of Functions and Input Parameters
21

function setMaxQtyOfMembers(

uint256 max

) external

(The sectary of company, i.e. the Direct Keeper of General Keeper) Set the max quantity of Members as max.
22

function setPayInAmt(

uint256 seqOfShare,

uint256 amt,

uint256 expireDate,

bytes32 hashLock

) external

(The sectary of company, i.e. the Direct Keeper of General Keeper) Set the intended pay in amount of amt for the share numbered as seqOfShare, before the date of expireDate, with the hash lock whose hash value is hashLock.
23

function requestPaidInCapital(

bytes32 hashLock,

string memory hashKey

) external

(The Member, after paying the paid in the relevant price off-chain) Request the specific paid in amount for the target share by inputting the hash key string hashKey to unlock the hash lock whose hash value is hashLock.
24

function withdrawPayInAmt(

bytes32 hashLock,

uint256 seqOfShare

) external

(The secrtary of the company, i.e. the Direct Keeper of General Keeper, after the expiration date of the relevant hash lock) Withdraw the setting for granting the pay in amount for the specific share numbered as seqOfShare, by inputting the hash lock value hashLock.
25

function payInCapital(

ICashier.TransferAuth memory auth,

uint256 seqOfShare,

uint256 paid

) external;

(The shareholder) Pay in capital, for its specific share numbered as seqOfShare, to the amount of paid as paid, by paying certain amount of USDC through off-chain authorization signed as auth.
26

function decreaseCapital(

uint seqOfVR,

uint256 seqOfShare,

uint paid,

uint par,

uint amt,

uint seqOfMotion

) external;

(The authorized executor) Decrease the registered capital of the share numbered as seqOfShare, as per the voting rule numbered as seqOfVR, with the paid value amount to paid, par value amount to par, and USDC value amount to amt, according to the passed resolution numbered as seqOfMotion.
6.5. APIs Routed to GMM Keeper
SNAPIDescription of Functions and Input Parameters
27

function nominateDirector(

uint256 seqOfPos,

uint256 candidate

) external

(The Member who has the nomination right) Nominate the user numbered as candidate for the Director’s position numbered as seqOfPos.
28

function createMotionToRemoveDirector(

uint256 seqOfPos

) external

(The Member who has the nomination right) Create a draft motion to remove the Director on the position numbered as seqOfPos.
29

function proposeDocOfGM(

uint256 doc,

uint256 seqOfVR,

uint256 executor

) external

(A Member) Create and propose a draft Motion for the General Meeting to approve the document deployed at the address of doc as per the voting rule numbered as seqOfVR with the user numbered as executor to invoke it.
30

function proposeToDistributeUsd(

uint amt,

uint expireDate,

uint seqOfVR,

uint seqOfDR,

uint para,

uint executor

) external;

(A Member) Create and propose a draft Motion for the General Meeting to approve distribution a sum of USDC amount to amt before the expiration date expireDate, as per the voting rule numbered as seqOfVR and the distribution rule numbered as seqOfDR, with the parameter of para and with the user numbered as executor to invoke it.
31

function proposeToTransferFundWithGM(

address to,

bool isCBP,

uint256 amt,

uint256 expireDate,

uint256 seqOfVR,

uint256 executor

) external

(A Member or Director) Propose, to the General Meeting, to transfer certain amount of CBP (isCBP is true) or USDC (isCBP is false), to the account address to, amount to amt, before the timestamp of expireDate, as per the Voting Rule numbered as seqOfVR, with the user numbered as executor to execute the Motion concerned.
32

function createActionOfGM(

uint seqOfVR,

address[] memory targets,

uint256[] memory values,

bytes[] memory params,

bytes32 desHash,

uint executor

) external

(A Member) Create a draft Motion for the General Meeting to execute a series of calls, as per the voting rule numbered as seqOfVR, to the contracts deployed at the addresses of targets, with paying the respective ETH amount to values, and inputting parameters of params, attached a description message whose hash value is desHash, with the user numbered as executor to invoke it.
33

function entrustDelegaterForGeneralMeeting(

uint256 seqOfMotion,

uint256 delegate

) external

(A Member) Entrust the user numbered as delegate to cast vote in General Meeting for the Motion numbered as seqOfMotion.
34

function proposeMotionToGeneralMeeting(

uint256 seqOfMotion

) external

(A Member) Proposes the Motion numbered as seqOfMotion to the General Meeting.
35

function castVoteOfGM(

uint256 seqOfMotion,

uint256 attitude,

bytes32 sigHash

) external

(A Member) Cast vote with the attitude for the Motion numbered as seqOfMotion with the signature message’s hash value as sigHash.
36

function voteCountingOfGM(

uint256 seqOfMotion

) external

(Any user) Count the vote result for the Motion on the General Meeting numbered as seqOfMotion.
37

function execActionOfGM(

uint typeOfAction,

address[] memory targets,

uint256[] memory values,

bytes[] memory params,

bytes32 desHash,

uint256 seqOfMotion

) external

(The designated executor) Execute the Motion numbered as seqOfMotion, categorized as typeOfAction, to trigger the series of calls to the contracts deployed at addresses of targets, with paying the respective ETH amount to values, inputting parameters as params, attached with hash value of the description message as desHash.
6.6. APIs Routed to ROA Keeper
SNAPIDescription of Functions and Input Parameters
38

function createIA(

uint256 version

) external

(Any Member) Create a draft Investment Agreement on the Register of Agreement, by cloning the Template of the version numbered as version.
39

function circulateIA(

address body,

bytes32 docUrl,

bytes32 docHash

) external

(The Member who is the Owner of the draft Investment Agreement) Circulate the finalized draft deployed at the address of body to the parties for signature, attaching with the URL information of docUrl and the hash value of the draft as docHash.
40

function signIA(

address ia,

bytes32 sigHash

) external

(The parties to the Investment Agreement) Sign the Investment Agreement deployed at the address of ia, with the signature message’s hash value as sigHash.
41

function pushToCoffer(

address ia,

uint256 seqOfDeal,

bytes32 hashLock,

uint256 closingDeadline

) external

(The seller) Confirm all conditions precedent have been satisfied and ready for closing, for the specific deal numbered as seqOfDeal, under the Investment Agreement deployed at the address of ia, by inputting a hash lock value hashLock and setting the closing deadline as closingDeadline.
42

function closeDeal(

address ia,

uint256 seqOfDeal,

string memory hashKey

) external

(The buyer) Close the deal numbered as seqOfDeal, under the Investment Agreement deployed at the address of ia, after paying the consideration off-chain, by inputting the hash key string hashKey.
43

function issueNewShare(

address ia,

uint256 seqOfDeal

) external

(The issuer) Issue new share directly to the buyer, for the capital increasing Deal numbered as seqOfDeal under the Investment Agreement deployed at the address of ia.
44

function transferTargetShare(

address ia,

uint256 seqOfDeal

) external

(The seller) Transfer the subject share directly to the buyer, for the specific share transfer Deal numbered as seqOfDeal under the Investment Agreement deployed at the address of ia.
45

function terminateDeal(

address ia,

uint256 seqOfDeal

) external

(The seller, after the expiration date concerned) Terminate the Deal numbered as seqOfDeal under the Investment Agreement deployed at the address of ia.
46

function payOffApprovedDeal(

ICashier.TransferAuth memory auth,

address ia,

uint256 seqOfDeal,

address to

) external;

(The buyer) Pay off the specific Deal numbered as seqOfDeal in the Investment Agreement deployed as the address of ia, by paying to the seller/issuer address to certain amount of USDC as per the off-chain authorization signed as auth, to close the Deal.
6.7. APIs Routed to ROO Keeper
SNAPIDescription of Functions and Input Parameters
47

function updateOracle(

uint256 seqOfOpt,

uint256 d1,

uint256 d2,

uint256 d3

) external

(The sectary of the company, i.e. the Direct Keeper of General Keeper) Update the key performance indicators of d1, d2, and d3, for the specific Option numbered as seqOfOpt.
48

function execOption(

uint256 seqOfOpt

) external

(The right holder) Execute the Option numbered as seqOfOpt.
49

function createSwap(

uint256 seqOfOpt,

uint256 seqOfTarget,

uint256 paidOfTarget,

uint256 seqOfPledge

) external

(The right holder) Create a Swap on the target share numbered as seqOfTarget, for paid value amount to paidOfTarget, with the collateral set up on the pledged share numbered as seqOfPledge, for executing the Option numbered as seqOfOpt.
50

function payOffSwap(

ICashier.TransferAuth memory auth,

uint256 seqOfOpt,

uint256 seqOfSwap,

address to

) external;

(The pledger) Pay certain amount of USDC as per the off-chain authorization signed as auth, to release the pledged share under the Swap numbered seqOfSwap of the Option numbered as seqOfOpt, to close the Swap.
51

function terminateSwap(

uint256 seqOfOpt,

uint256 seqOfSwap

) external

(The target share holder) Execute the swap numbered as seqOfSwap of the Option numbered as seqOfOpt, by transferring the target share and releasing the pledged share.
6.8. APIs Routed to ROP Keeper
SNAPIDescription of Functions and Input Parameters
52

function createPledge(

bytes32 snOfPld,

uint256 paid,

uint256 par,

uint256 guaranteedAmt,

uint256 execDays

) external

(Any shareholder) Create a Pledge with the codified serial number snOfPld amount to paid value of paid and par value of par to guarantee the debt amount to guarantedAmt with the guarantee period lasting for number of days of execDays.
53

function transferPledge(

uint256 seqOfShare,

uint256 seqOfPld,

uint256 buyer,

uint256 amt

) external

(The creditor) Transfer the Pledge numbered as seqOfPld setting up on the pledged share numbered seqOfShare to the user numbered as buyer with the credit amount to amt.
54

function refundDebt(

uint256 seqOfShare,

uint256 seqOfPld,

uint256 amt

) external

(The creditor) Confirm refunding of the debt, guaranteed by the Pledge numbered as seqOfPld setting on the pledged share numbered as seqOfShare, by the amount of amt.
55

function extendPledge(

uint256 seqOfShare,

uint256 seqOfPld,

uint256 extDays

) external

(The pledger) Extend the guarantee period of the Pledge numbered as seqOfPld setting on the pledged share numbered as seqOfShare for a such number of days as extDays.
56

function lockPledge(

uint256 seqOfShare,

uint256 seqOfPld,

bytes32 hashLock

) external

(The creditor) Set up a hash lock with the hash value as hashLock on the Pledge numbered as seqOfPld setting on the pledged share numbered seqOfShare.
57

function releasePledge(

uint256 seqOfShare,

uint256 seqOfPld,

string memory hashKey

) external

(The pledger, after paying off-chain and obtaining the hash key) Release the Pledge numbered as seqOfPld setting on the pledged share numbered seqOfShare by inputting the hash key string hashKey.
58

function execPledge(

uint256 seqOfShare,

uint256 seqOfPld,

uint256 buyer,

uint256 groupOfBuyer

) external

(The creditor, after off-chain disposal and receipt of the consideration) Execute the Pledge numbered as seqOfPld setting on the pledged share numbered as seqOfShare to transfer the target share to the user numbered as buyer who belongs to the concert group represented by the user numbered as groupOfBuyer.
59

function revokePledge(

uint256 seqOfShare,

uint256 seqOfPld

) external

(The pledger, after the expiration of the guarantee period) Revoke the Pledge numbered as seqOfPld setting on the pledged share numbered as seqOfShare.
6.9. APIs Routed to SHA Keeper
SN.APIDescription of Functions and Input Parameters
60

function execAlongRight(

address ia,

bytes32 snOfClaim,

bytes32 sigHash

) external

(The right holder) Execute the Tag-Along right, for the tag along or drag along Claim encoded as snOfClaim in the Investment Agreement deployed at the address of ia, with the signature’s hash value as sigHash.
61

function acceptAlongDeal(

address ia,

uint256 seqOfDeal,

bytes32 sigHash

) external

(The buyer) Accepts the Tag/Drag Along requests, for the Deal numbered as seqOfDeal of the Investment Agreement deployed at the address of ia, with the signature’s hash value as sigHash.
62

function execAntiDilution(

address ia,

uint256 seqOfDeal,

uint256 seqOfShare,

bytes32 sigHash

) external

(The right holder) Execute the Anti-Dilution right, towards the Deal numbered as seqOfDeal in the Investment Agreement deployed at the address of ia, for its share numbered seqOfShare, with the signature hash value as sigHash.
63

function takeGiftShares(

address ia,

uint256 seqOfDeal

) external

(The right holder of Anti-Dilution, after the closing) Take the gift shares, generating as per the Anti-Dilution Term of SHA, for the Deal numbered as seqOfDeal in the Investment Agreement deployed at the address of ia.
64

function execFirstRefusal(

uint256 seqOfRule,

uint256 seqOfRightholder,

address ia,

uint256 seqOfDeal,

bytes32 sigHash

) external

(The right holder) Execute its First Refusal right, as per the Rule numbered as seqOfRule, with the identified sequence number as seqOfRightholder, to request to buy the subject share of the Deal numbered as seqOfDeal in the Investment Agreement deployed at the address of ia, with the signature hash value as sigHash.
65

function computeFirstRefusal(

address ia,

uint256 seqOfDeal

) external;

(Any Member) Compute the First Refusal claims result for the Deal numbered as seqOfDeal of the Investment Agreement deployed at the address of ia, so as to obtain the automatically updated Investment Agreement.
6.10. APIs Routed to Accountant
SNAPIDescription of Functions and Input Parameters
66

function initClass(

uint class

) external;

(Secretary of the Company) Initiate a specific class of shares to calculate ROE or IRR.
67

function distributeProfits(

uint256 amt,

uint256 expireDate,

uint256 seqOfDR,

uint256 seqOfMotion

) external

(The designated executor) Distribute the profits of the company amount to amt, as per the distribution rule numbered as seqOfDR and the Motion numbered as seqOfMotion, before the expiration date of expireDate.
68

function distributeIncome(

uint256 amt,

uint256 expireDate,

uint256 seqOfDR,

uint256 fundManager,

uint256 seqOfMotion

) external

(The designated executor) Distribute the income of the fund amount to amt, as per the Motion numbered as seqOfMotion, before the expiration date of expireDate, with the user number of the asset manager as fundManager.
69

function transferFund(

bool fromBMM,

address to,

bool isCBP,

uint256 amt,

uint256 expireDate,

uint256 seqOfMotion

) external

(The designated executor) Transfer, CBP (isCBP is true) or ETH (isCBP is false), to the account address to, amount to amt, as per the Motion passed by, the Board (toBMM is true) or the General Meeting (toBMM is false), before the timestamp of expireDate, numbered as seqOfMotion.
6.11. APIs Routed to ROI Keeper
SNAPIDescription of Functions and Input Parameters
70

function pause(

uint seqOfLR

) external

(The authorized Enforcer) Pause temporarily the trade of the shares as per the listing rule numbered as seqOfLR.
71

function unPause(

uint seqOfLR

) external

(The authorized Enforcer) Restore the trade of the shares as per the listing rule numbered as seqOfLR.
72

function regInvestor(

address bKey,

uint256 groupRep,

bytes32 idHash

) external

(Any user) Register itself as an investor, by inputting its backup key as bKey, the user number of its concert group’s representative as groupRep, with the hash value of its identity information as idHash.
73

function approveInvestor(

uint256 userNo,

uint256 seqOfLR

) external

(The verifier) Approve the investor’s application, pursuant to the Listing Rule numbered as seqOfLR, filed by the user numbered as userNo.
74

function revokeInvestor(

uint256 userNo,

uint256 seqOfLR

) external

(The verifier) Revoke the investor’s qualification of the user numbered as userNo, pursuant to the Listing Rule numbered as seqOfLR.
75

function freezeShare(

uint seqOfLR,

uint seqOfShare,

uint paid,

bytes32 hashOrder

) external;

(The authorized Enforcer) Freezes the target share identified by sequence number seqOfShare, with its paid amount recorded as paid, pursuant to the authorization set forth in Listing Rule seqOfLR, and in accordance with the execution order identified by the hash value hashOrder.
76

function unfreezeShare(

uint seqOfLR,

uint seqOfShare,

uint paid,

bytes32 hashOrder

) external;

(The authorized Enforcer) Unfreezes the target share identified by sequence number seqOfShare, with its paid amount recorded as paid, pursuant to the authorization set forth in Listing Rule seqOfLR, and in accordance with the execution order identified by the hash value hashOrder.
77

function forceTransfer(

uint seqOfLR,

uint seqOfShare,

uint paid,

address addrTo,

bytes32 hashOrder

) external;

(The authorized Enforcer) Forcibly transfers the target share identified by sequence number seqOfShare, with its paid amount recorded as paid, to the specified user whose primary key address is addrTo, pursuant to the authorization set forth in Listing Rule seqOfLR, and in accordance with the execution order identified by the hash value hashOrder
6.12. APIs Routed to LOO Keeper
SNAPIDescription of Functions and Input Parameters
78

function placeInitialOffer(

uint256 classOfShare,

uint256 execHours,

uint256 paid,

uint256 price,

uint256 seqOfLR

) external

(The issuer) Place an initial offer for the class of classOfShare, as per the authorization of the Listing Rule numbered as seqOfLR,at the price of paid as price, to the amount of paid as paid, with the available number of hours as execHours.
79

function withdrawInitialOffer(

uint256 classOfShare,

uint256 seqOfOrder,

uint256 seqOfLR

) external;

(The issuer) Withdraw the initial offer numbered as seqOfOrder under the class of classOfShare, as per the authorization of the Listing Rule numbered as seqOfLR.
80

function placeSellOrder(

uint256 seqOfClass,

uint256 execHours,

uint256 paid,

uint256 price,

uint256 seqOfLR

) external

(Any qualified investor) Place a sell order under the class numbered as seqOfClass, as per the Listing Rule of seqOfLR, to the paid value amount to paid, at the selling price of price, with the available time within the number of hours as execHours.
81

function withdrawSellOrder(

uint256 classOfShare,

uint256 seqOfOrder

) external

(The seller) Withdraw the sell order placed by itself numbered as seqOfOrder for the class of classOfShare.
82

function placeBuyOrder(

ICashier.TransferAuth

memory auth,

uint256 classOfShare,

uint256 paid,

uint256 price,

uint256 execHours

) external

(Any qualified investor) Place a buy order for the class of classOfShare, to the paid value amount to paid, at the buy price of price, within the available time as number of hours of execHours, paying certain amount of USDC as per the off-chain authorization signed as auth.
83

function placeMarketBuyOrder(

ICashier.TransferAuth

memory auth,

uint256 classOfShare,

uint256 paid,

uint256 execHours

) external

(Any qualified investor) Place a buy order for the class of classOfShare, to the paid value amount to paid, at the market price, with the available time within the number of hours as execHours, paying certain amount of USDC as per the off-chain authorization signed as auth.
84

function withdrawBuyOrder(

uint256 classOfShare,

uint256 seqOfOrder

) external

(The buyer) Withdraw the buy order numbered as seqOfOrder for the class of classOfShare that it has placed.
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://comboox.gitbook.io/whitepaper-en/system-overview/6.-external-write-apis.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.