createAccount

Format de demande

default namespace = ""

start =
element account {
  attribute parentId { xsd:integer }, #id of the parent account the new account should roll up to
   attribute name { xsd:string { maxLength="2048" minLength="1"} }, #Non-empty string with a maximum length of 2048 characters.
  attribute isGroup { string "0" | string "1" }, #0=No, 1=Yes
  attribute code { xsd:string { maxLength="2048"} }, #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 }
    }*
  }?
}

Exemple

<?xml version='1.0' encoding='UTF-8'?>
<call method="createAccount" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <account 
          parentId="441" 
          isGroup="0"
          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>

Format de réponse

Exemple de réussite

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <messages>
  <message type="WARNING" key="warning-unpublished-changes" values="" parentId="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="AssetsChild" name="AssetsChild" timeStratum="month" description="Total Assets Child" 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" />
   </accounts>
 </output>
</response>

Exemple d'erreur

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