| Info | ||
|---|---|---|
| ||
The information in this document is currently in BETA and subject to change. |
The Settings resource is a Read-Only resource that represents the general system, division and accounting configuration information for the accessed accountsystem. This information is critical to displaying data in formats and ways that are familiar to, and desired by the resource owner. Specific settings can be requested using their setting name or all of the settings may be returned by requesting the entire resource.
...
| Field | Description | Format | Required | Field Type | Notes | |
|---|---|---|---|---|---|---|
| organizationKey | The unique key given to the accessing organization. | string | true | default | ||
| emptyMergeFieldFormat | The default format for missing merge field data. | string | true | default | ||
| timeRecordingPrecision | The number of decimal places to record time to. | number | true | default | ||
| timeRecordingRounding | The rounding method used when using 1 decimal place. | string | true | default | ||
| actionAlias | The alias for the Actions resourcevalue | The value of the setting. | string | true | default | |
| actionsAlias | The alias for the Actions resource. (Plural) | string | true | default | ||
| participantAlias | The alias for the Participants resource. | string | true | default | ||
| participantsAlias | The alias for the Participants resource. (Plural) | string | true | default | ||
| contactsLimit | Option to show all contacts in system or limit by division. | string | true | default | ||
| inputDateFormat | The expected format user entered dates. | string | true | default | ||
| shortDateFormat | The desired format for short formatted dates. | string | true | default | ||
| longDateFormat | The desired format for long formatted dates. | string | true | default | ||
| firstDayOfWeek | The desired first day of the month. | string | true | default | ||
| customerParticipant | The Participant Type to be designated as the "Customer" across the system. | string | true | default | ||
| bankParticipant | The Participant Type to be designated as the "Bank" across the system. | string | true | default | ||
| supplierParticipant | The Participant Type to be designated as the "Supplier" across the system. | string | true | default | ||
| salesParticipant | The Participant Type to be designated as the "Salesperson" across the system. | string | true | default | ||
| country | The associated Countries resource for the organization. | string | true | link | ||
| accountingSettings | The system accounting settings. | string | false | link |
| description | A description detailing how the setting is used. | string | false | default |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| settings.country | countries | /countries/{settings.country} |
| settings.accountingSettings | accountingSettings | /accountingSettings