> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.
# documentfavourites
## "documentfavourites"
This provider name is implemented by the class SuperOffice.CRM.ArchiveLists.DocumentFavouritesProvider inside NetServer's SODatabase assembly.
## Supported Entities
| Name | Description |
| ---------- | ------------------ |
| "document" | Favourite document |
## Supported Columns
| Name | Restriction | Description | OrderBy |
| -------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| getAllRows | bool | GetAll: Get all rows of archive - use with care, you may be fetching the whole database | |
| getNoRows | bool | GetNone: Do not get any rows from the archive | |
| completed | bool | Completed: Displays a checkbox showing if an appointment is completed | x |
| icon | listAny | Category: Displays the icon for an activity type | x |
| date | date | Date: Displays start date of a follow-up / sale date of a sale | x |
| time | *None* | Time: Time | |
| type | listAny | Type: Displays the type of an activity | x |
| recordType | string | Record type : Shows the record type | x |
| text | positiveString | Favourite: Displays a descriptive text for the item | x |
| associateId | associate | ID: Displays the login ID of the associate who owns the activity. | x |
| contactId | listAny | Company ID: Database ID of company | x |
| personId | listAny | Contact ID: Database ID of the contact row | x |
| projectId | listAny | Project ID: Database ID of project record | x |
| saleId | int | Sale ID: The database ID of the sale record | x |
| userGroup | userGroup | User group : The user group that owns the record | x |
| who | *None* | Who: Contact and/or company | |
| updatedBy | associate | Updated by: The user who last updated the data | x |
| updatedByFullName | associate | Updated by - Full name: The user who last updated the data | x |
| updatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
| registeredBy | associate | Registered by: The user who registered the data | x |
| registeredByFullName | associate | Registered by - Full name: The user who registered the data | x |
| registeredDate | date | Registered date: The date/time the data was registered in UTC. | x |
| documentId | int | Document ID: Database ID of document record | x |
| keywords | string | Keywords | x |
| ourref | string | Our ref. | x |
| yourref | string | Your ref. | x |
| attention | string | Salutation | x |
| subject | string | Subject | x |
| name | string | File name | x |
| mailMergeDraft | bool | Mail merge draft : Indicates whether the document is a mail merge template | x |
| snum | int | Document number: Serial number of document. It can be generated by the number allocation system for a dedicated document template. | x |
| isReport | bool | Report: Is this document a saved report run? | |
| suggestedDocumentId | int | Document ID (suggestion): The database ID of a document that originates in a suggestion | x |
| isMail | bool | E-mail | |
| recordTypeText | *None* | Activity type: The type of the activity (appointment, phone call, etc) | x |
| entityIcon | *None* | Row specific icon: Row specific icon | x |
| favouriteAssociateId | associate | ID: Displays the login ID of the associate who owns the activity. | x |
| visibleFor | listAny | Visible for | |
| documentPublish/isPublished | bool | Published: Displays an icon indicating if the project or sale has been published | x |
| documentPublish/publishedFrom | date | From date: Start date for publishing. The record will not be visible prior to this date | x |
| documentPublish/publishedTo | date | To date: End date for publishing. The record will not be visible after this date | x |
| documentPublish/publishedBy | *None* | Published by: Published by | |
| associate/firstName | string | First name: Displays the contact's first name | x |
| associate/lastName | string | Last name: Displays the contact's last name | x |
| associate/middleName | string | Middle Name : Displays the contact's middle name. | x |
| associate/fullName | string | Full name: Displays full name of user (first, middle, last - according to settings) | x |
| associate/contactId | int | Company ID: Database ID of the company the user belongs to | |
| associate/personId | int | Contact ID: Database ID of the contact row | |
| associate/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
| associate/title | string | Title: Displays whether the contact is addressed as Mr or Ms | x |
| associate/associateDbId | associate | ID | x |
| associate/contactName | string | Owning company: Name of the company the user belongs to | x |
| associate/contactDepartment | string | Owning department: Name of the department at the company the user belongs to | x |
| associate/usergroup | userGroup | Primary group: The user's primary user group | x |
| associate/usergroupId | int | Group ID: The user's primary user group | x |
| associate/contactFullName | string | Owner: Name and department of the company the user belongs to | x |
| associate/contactCategory | listAny | Category: Category | x |
| associate/role | listAny | Role : Role | x |
| associate/assocName | associate | User ID : User ID | x |
| associate/assocTooltip | string | Description : Description | |
| associate/assocType | listAny | Type: Type of user: associate, external user, system user, anonymous account | x |
| associate/ejUserId | int | Service user ID: The database ID of a Service user | |
| associate/simultaneousEjUser | bool | Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded | |
| associate/ejDisplayName | string | Nickname: User's nickname in Service | x |
| associate/ejStatus | int | Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only | |
| associate/credentialType | *None* | Auth. type: What type of credentials to use when this user logs in | x |
| associate/credentialDisplayValue | *None* | Auth. value: Credential value (public, visible part) to be used when this user logs in | x |
| associate/isActive | bool | Active: Is this user active, and should be able to log in? | x |
| associate/isActiveText | bool | Active status: Is this user active, and should be able to log in? | x |
| associate/portraitThumbnail | *None* | Person image: Person image | |
| associate/otherGroups | userGroup | Other groups: Other groups | |
| associate/userName | string | User name: User name | x |
| associate/personEmail | string | E-mail | x |
| associate/locationAddress | string | Location: Location | x |
| associate/isLocation | bool | Is a location: Is a location | x |
| documentUdef/SuperOffice:1 | string | documentshorttext | x |
| documentUdef/SuperOffice:2 | string | documentlongtext | x |
| documentUdef/SuperOffice:3 | int | documentnumber | x |
| documentUdef/SuperOffice:4 | date | documentdate | x |
| documentUdef/SuperOffice:5 | unlimitedDate | documentunlimiteddate | x |
| documentUdef/SuperOffice:6 | bool | documentcheckbox | x |
| documentUdef/SuperOffice:7 | listAny | documentdropdownlistbox | x |
| documentUdef/SuperOffice:8 | decimal | documentdecimal | x |
| document/textId | int | Text ID | x |
| document/description | positiveString | Text: Displays the text entered in the description field | x |
## Sample
```http! theme={null}
GET /api/v1/archive/documentfavourites?$select=name,associate/firstName
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
```
See also: IArchiveAgent.
## Related topics
- [documentfavourite](/en/api/mdo-providers/reference/documentfavourite.md)
- [Archive Provider List](/en/api/archive-providers/reference/index.md)
- [MDO List Provider names](/en/api/mdo-providers/reference/index.md)