updateAccount

リクエストのフォーマット

default namespace = ""
start =
    element account {
        attribute id { xsd:integer }, #account id
        attribute name { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute code { xsd:string { maxLength="2048" minLength="1"} }?, #Non-empty string with a maximum length of 2048 characters.
    attribute description { xsd:string { maxLength="2048"} }?, #Potentially empty string with a maximum length of 2048 characters.
    attribute shortName { xsd:string { maxLength="64"} }?, #Potentially empty string with a maximum length of 64 characters.
    attribute exchangeRateType { xsd:string }?, #displayAs must be CURRENCY (only if multicurrency is enabled) attribute hasSalaryDetail { string "0" | string "1" }?, #0=No, 1=Yes
    attribute dataPrivacy { string "PRIVATE" | string "PUBLIC_TOP" | string "PUBLIC_ALL" }?,
    attribute isBreakbackEligible { string "0" | string "1" }?, #0=No, 1=Yes
    attribute proceedWithWarnings { string "0" | string "1" }?, #0=No, 1=Yes
    element attributes{
        element attribute{
            attribute attributeId{ xsd:integer },
            attribute valueId{ xsd:integer }
        }* 
    }?
}

例

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAccount" callerName="a string that identifies your client application">
    <credentials login="sampleuser@company.com" password="my_pwd"/>
    <account
        id="48"
        name="Account Name"
        code="Account_Code"
        description="Account Description"
        shortName="Short Name"
        exchangeRateType="A"
        hasSalaryDetail="1"
        dataPrivacy="PRIVATE" >
        <attributes>
            <attribute attributeId="20" valueId="170" />
        </attributes>
    </account>
</call>

回答フォーマット

成功例

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
    <messages>
        <message type="WARNING" key="warning-unpublished-changes" values="" accountId="1">You have unpublished changes. 
            Your changes will not be visible every where until it is published.</message>
    </messages>
    <output>
        <accounts>
            <account id="1" code="Assets" name="Assets" description="Total Assets" timeStratum="month" displayAs="CURRENCY" accountTypeCode="A" decimalPrecision="0" isAssumption="0" suppressZeroes="1" isDefaultRoot="1" shortName="" exchangeRateType="E" balanceType="DEBIT" formula="" isLinked="0" owningSheetId="" isSystem="0" isIntercompany="0" dataEntryType="" planBy="DELTA" timeRollup="LAST" timeWeightAcctId="" levelDimRollup="SUM" levelDimWeightAcctId="" rollupText="" startExpanded="1" hasSalaryDetail="" dataPrivacy="PRIVATE" isBreakbackEligible="" subType="CUMULATIVE" enableActuals="1" isGroup="0">
               <attributes>
                   <attribute
                   name="AP Eligible"
                   attributeId="17"
                   value="Yes"
                   valueId="170" />
               </attributes>
               </account>
        </accounts>
    </output>
</response>

エラーの例

<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
    <messages>
       <message type="ERROR" key="invalid-account-id" values="441" accountId="-50">Invalid account id: "-50"</message>
    </messages>
</response>