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

  1 Status: 200 OK
  2 
  3 <account>
  4   <name>artworks</name>
  5   <display-name>ArtWorks Image Restoration</display-name>
  6   <!-- if include=[all || billing_settings] -->
  7   <billing-settings>
  8     <enable-billing type="boolean">true</enable-billing>
  9   </billing-settings>
 10   <!-- end -->
 11   <!-- if include=[all || time_settings] -->
 12   <time-settings>
 13     <enable-time-tracking type="boolean">true</enable-time-tracking>
 14     <show-activities type="boolean">true</show-activities>
 15     <activity-name>activity</activity-name>
 16     <activity-name-plural>activities</activity-name-plural>
 17     <show-activity-codes type="boolean">true</show-activity-codes>
 18     <show-activity-links type="boolean">true</show-activity-links>
 19     <show-activity-descriptions type="boolean">true</show-activity-descriptions>
 20   </time-settings>
 21   <!-- end -->
 22   <!-- if include=[all || expense_settings] -->
 23   <expense-settings>
 24     <enable-expenses type="boolean">true</enable-expenses>
 25     <show-payment-methods type="boolean">true</show-payment-methods>
 26     <show-payment-method-codes type="boolean">true</show-payment-method-codes>
 27     <show-payment-method-links type="boolean">true</show-payment-method-links>
 28     <show-payment-method-descriptions type="boolean">true</show-payment-method-descriptions>
 29     <show-expense-categories type="boolean">true</show-expense-categories>
 30     <show-expense-category-codes type="boolean">true</show-expense-category-codes>
 31     <show-expense-category-links type="boolean">true</show-expense-category-links>
 32     <show-expense-category-descriptions type="boolean">true</show-expense-category-descriptions>
 33     <show-expense-taxes type="boolean">true</show-expense-taxes>
 34   </expense-settings>
 35   <!-- end -->
 36   <!-- if include=[all || user_settings] -->
 37   <user-settings>
 38     <enable-assignments type="boolean">true</enable-assignments>
 39     <show-user-codes type="boolean">true</show-user-codes>
 40     <show-user-links type="boolean">true</show-user-links>
 41     <show-user-group-codes type="boolean">true</show-user-group-codes>
 42     <show-user-group-links type="boolean">true</show-user-group-links>
 43     <show-user-group-descriptions type="boolean">true</show-user-group-descriptions>
 44   </user-settings>
 45   <!-- end -->
 46   <!-- if include=[all || currencies] -->
 47   <currencies type="array">
 48     <currency>
 49       <code>USD</code>
 50       <symbol>$</symbol>
 51       <!-- currency-format: 0 - Code, then amount (e.g. USD 100)
 52                             1 - Amount, then code (e.g. 100 USD)
 53                             2 - Symbol, then amount (e.g. $100)
 54                             3 - Amount, then symbol (e.g. 100$) -->
 55       <currency-format type="integer">2</currency-format>
 56       <supports-cents type="boolean">true</supports-cents>
 57       <default type="boolean">true</default>
 58     </currency>
 59     <currency>
 60       ...
 61     </currency>
 62   </currencies>
 63   <!-- end -->
 64   <!-- if include=[all || job_types] -->
 65   <job-types type="array">
 66     <job-type>
 67       <id type="integer">7</id>
 68       <parent-id type="integer" nil="true"/>
 69       <name>client</name>
 70       <name-plural>clients</name-plural>
 71       <allow-time-entries type="boolean">false</allow-time-entries>
 72       <allow-expense-entries type="boolean">false</allow-expense-entries>
 73       <show-codes type="boolean">true</show-codes>
 74       <show-links type="boolean">true</show-links>
 75       <show-descriptions type="boolean">true</show-descriptions>
 76       <levels type="integer">1</levels>
 77     </job-type>
 78     <job-type>
 79       <id type="integer">8</id>
 80       <parent-id type="integer">7</parent-id>
 81       <name>project</name>
 82       <name-plural>projects</name-plural>
 83       <allow-time-entries type="boolean">true</allow-time-entries>
 84       <allow-expense-entries type="boolean">true</allow-expense-entries>
 85       <show-codes type="boolean">true</show-codes>
 86       <show-links type="boolean">true</show-links>
 87       <show-descriptions type="boolean">true</show-descriptions>
 88       <levels type="integer">1</levels>
 89     </job-type>
 90     <job-type>
 91       <id type="integer">9</id>
 92       <parent-id type="integer">8</parent-id>
 93       <name>task</name>
 94       <name-plural>tasks</name-plural>
 95       <allow-time-entries type="boolean">true</allow-time-entries>
 96       <allow-expense-entries type="boolean">true</allow-expense-entries>
 97       <show-codes type="boolean">true</show-codes>
 98       <show-links type="boolean">true</show-links>
 99       <show-descriptions type="boolean">true</show-descriptions>
100       <!-- The lowest level job type may contain more than one level of jobs -->
101       <levels type="integer">2</levels>
102     </job-type>
103   </job-types>
104   <!-- end -->
105 </account>

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

Continue to User Information

Follow Syncd on Twitter Subscribe to the Syncd News