Account Information

A single request can obtain almost all the information about the logged in user’s account. Administrators can update this information using Syncd’s web interface, but not via the API.

Request

GET /info/account.xml

Optional parameters

Use the following optional parameters to control which information is included in the response:

include=[all,
         billing_settings,
         time_settings,
         expense_settings,
         user_settings,
         currencies,
         job_types]

For instance, the following request will get all available information about the account:

GET /info/account.xml?include=all

Response

Status: 200 OK

<account>
  <name>artworks</name>
  <display-name>ArtWorks Image Restoration</display-name>
  <!-- if include=[all || billing_settings] -->
  <billing-settings>
    <enable-billing type="boolean">true</enable-billing>
  </billing-settings>
  <!-- end -->
  <!-- if include=[all || time_settings] -->
  <time-settings>
    <enable-time-tracking type="boolean">true</enable-time-tracking>
    <show-activities type="boolean">true</show-activities>
    <activity-name>activity</activity-name>
    <activity-name-plural>activities</activity-name-plural>
    <show-activity-codes type="boolean">true</show-activity-codes>
    <show-activity-links type="boolean">true</show-activity-links>
    <show-activity-descriptions type="boolean">true</show-activity-descriptions>
  </time-settings>
  <!-- end -->
  <!-- if include=[all || expense_settings] -->
  <expense-settings>
    <enable-expenses type="boolean">true</enable-expenses>
    <show-payment-methods type="boolean">true</show-payment-methods>
    <show-payment-method-codes type="boolean">true</show-payment-method-codes>
    <show-payment-method-links type="boolean">true</show-payment-method-links>
    <show-payment-method-descriptions type="boolean">true</show-payment-method-descriptions>
    <show-expense-categories type="boolean">true</show-expense-categories>
    <show-expense-category-codes type="boolean">true</show-expense-category-codes>
    <show-expense-category-links type="boolean">true</show-expense-category-links>
    <show-expense-category-descriptions type="boolean">true</show-expense-category-descriptions>
    <show-expense-taxes type="boolean">true</show-expense-taxes>
  </expense-settings>
  <!-- end -->
  <!-- if include=[all || user_settings] -->
  <user-settings>
    <enable-assignments type="boolean">true</enable-assignments>
    <show-user-codes type="boolean">true</show-user-codes>
    <show-user-links type="boolean">true</show-user-links>
    <show-user-group-codes type="boolean">true</show-user-group-codes>
    <show-user-group-links type="boolean">true</show-user-group-links>
    <show-user-group-descriptions type="boolean">true</show-user-group-descriptions>
  </user-settings>
  <!-- end -->
  <!-- if include=[all || currencies] -->
  <currencies type="array">
    <currency>
      <code>USD</code>
      <symbol>$</symbol>
      <!-- currency-format: 0 - Code, then amount (e.g. USD 100)
                            1 - Amount, then code (e.g. 100 USD)
                            2 - Symbol, then amount (e.g. $100)
                            3 - Amount, then symbol (e.g. 100$) -->
      <currency-format type="integer">2</currency-format>
      <supports-cents type="boolean">true</supports-cents>
      <default type="boolean">true</default>
    </currency>
    <currency>
      ...
    </currency>
  </currencies>
  <!-- end -->
  <!-- if include=[all || job_types] -->
  <job-types type="array">
    <job-type>
      <id type="integer">7</id>
      <parent-id type="integer" nil="true"/>
      <name>client</name>
      <name-plural>clients</name-plural>
      <allow-time-entries type="boolean">false</allow-time-entries>
      <allow-expense-entries type="boolean">false</allow-expense-entries>
      <show-codes type="boolean">true</show-codes>
      <show-links type="boolean">true</show-links>
      <show-descriptions type="boolean">true</show-descriptions>
      <levels type="integer">1</levels>
    </job-type>
    <job-type>
      <id type="integer">8</id>
      <parent-id type="integer">7</parent-id>
      <name>project</name>
      <name-plural>projects</name-plural>
      <allow-time-entries type="boolean">true</allow-time-entries>
      <allow-expense-entries type="boolean">true</allow-expense-entries>
      <show-codes type="boolean">true</show-codes>
      <show-links type="boolean">true</show-links>
      <show-descriptions type="boolean">true</show-descriptions>
      <levels type="integer">1</levels>
    </job-type>
    <job-type>
      <id type="integer">9</id>
      <parent-id type="integer">8</parent-id>
      <name>task</name>
      <name-plural>tasks</name-plural>
      <allow-time-entries type="boolean">true</allow-time-entries>
      <allow-expense-entries type="boolean">true</allow-expense-entries>
      <show-codes type="boolean">true</show-codes>
      <show-links type="boolean">true</show-links>
      <show-descriptions type="boolean">true</show-descriptions>
      <!-- The lowest level job type may contain more than one level of jobs -->
      <levels type="integer">2</levels>
    </job-type>
  </job-types>
  <!-- end -->
</account>

Job types will always be returned in order, starting at the base level. Job types are explained in further detail here.