> ## 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. # Create E Mail From Document Entity > Get an e-mail based on the provided DocumentEntity NsApiSlow threshold: 5000 ms. ## Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered. ## OpenAPI ````yaml /openapi/agent/openapi-v3-EMailAgent.json post /api/v1/Agents/EMail/CreateEMailFromDocumentEntity openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - EMailAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/EMail/CreateEMailFromDocumentEntity: post: tags: - EMail_Agent summary: Create E Mail From Document Entity description: "Get an e-mail based on the provided DocumentEntity\n\nNsApiSlow threshold: 5000 ms.\r\n## Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered." operationId: v1EMailAgent_CreateEMailFromDocumentEntity parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest description: DocumentEntity required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEntity' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.EMailCarriers.CreateEMailFromDocumentEntityRequest: description: >- CreateEMailFromDocumentEntity: Get an e-mail based on the provided DocumentEntity type: object properties: DocumentEntity: $ref: '#/components/schemas/SuperOffice.CRM.Services.DocumentEntity' SuperOffice.CRM.Services.EMailEntity: description: "All information about an e-mail\r\n\r\nCarrier object for EMailEntity.\r\nServices for the EMailEntity Carrier is available from the EMail Agent." type: object properties: To: description: To recipients of e-mail type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' Cc: description: Cc recipients of e-mail type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' Bcc: description: Bcc recipient of e-mail type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' Subject: description: Subject of the e-mail type: string HTMLBody: description: Body formatted in HTML type: string From: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' Sent: format: date-time description: When was the e-mail sent type: string Size: format: int32 description: Total size of the e-mail type: integer Priority: description: Importance of the e-mail enum: - NoPriority - Highest - High - Normal - Low - Lowest type: string Flags: description: Flag status of this mail (unread, replied, deleted ) enum: - None - Seen - Deleted - Recent - Flagged - Draft - Answered type: string MessageID: description: Unique id of e-mails type: string PlainBody: description: Body formatted in plain text type: string IsSent: description: Is this a sent e-mail (not new) type: boolean EMailSOInfo: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailSOInfo' ServerId: format: int32 description: Unique id for the e-mail on the server type: integer ServerIdentifier: description: Server identifier of this email item (GraphApi uses string Id's) type: string Attachments: description: '' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAttachment' CustomHeaderList: description: Non standard e-mail headers type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailCustomHeader' FolderName: description: Name of folder the e-mail belongs in type: string EmailItemId: format: int32 description: Primary key type: integer AccountId: format: int32 description: Account Id type: integer ReceivedAt: format: date-time description: Received date time type: string InReplyTo: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailEnvelope' RepliedAt: format: date-time description: When this email was replied at type: string HasCalendarData: description: If this email contains exactly one iCal appointment type: boolean CalMethod: description: >- Method stored in the associated iCal appointment. Indicates if the iCal data is a reply, counter proposal etc. enum: - Unknown - Add - Cancel - Counter - DeclineCounter - Publish - Refresh - Reply - Request type: string CalReplyStatus: description: Reply status stored in calendar data for the ical method is REPLY enum: - Unknown - Accepted - Declined - Tentative type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.DocumentEntity: description: >- Partial DocumentEntity class associating the generated DocumentEntity with an interface. type: object properties: DocumentId: format: int32 description: Primary key type: integer UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Attention: description: Attention/salutation type: string Header: description: Visible document name type: string Name: description: File name type: string OurRef: description: Our reference, searchable field from freetext search type: string YourRef: description: Your reference type: string CreatedDate: format: date-time description: Registered when in UTC. type: string UpdatedDate: format: date-time description: Last updated when in UTC. type: string Description: description: >- The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases type: string DocumentTemplate: $ref: '#/components/schemas/SuperOffice.CRM.Services.DocumentTemplate' Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' Associate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Contact: $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact' Project: $ref: '#/components/schemas/SuperOffice.CRM.Services.Project' Date: format: date-time description: date + start time planned type: string ExternalRef: description: >- External reference for document plugin to resolve document identity (Notes ID, e-mail message ID, whatever) type: string Completed: description: Document Completed state. This is the part of the Status property. enum: - Unknown - NotStarted - Started - Completed type: string ActiveLinks: format: int32 description: Number of active links to sale, document, appointment. type: integer Type: description: Is this a normal document or a mail-merge or report? enum: - Unknown - inDiary - inChecklist - Note - Document - SavedReport - BookingForDiary - BookingForChecklist - MergeDraft - MergeFinal type: string Links: description: List of all elements linked to the document. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.Link' LockSemantics: description: '' enum: - None - Locking - Versioning type: string Sale: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sale' SuggestedDocumentId: format: int32 description: >- Suggested guide item that this document is an instance of (Note: NOT valid for appointments, they have their own link) type: integer Snum: format: int32 description: >- The sequence number allocated from refcount on used template when creating the document type: integer UserDefinedFields: description: "Deprecated: Use {SuperOffice.CRM.Services.DocumentEntity.CustomFields} instead.\r\nDictionary of user defined field data.\r\nThe key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format \"SuperOffice:[UdefFieldIdentity]\", e.g. \"SuperOffice:1234\"" type: object additionalProperties: type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.DocumentEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.DocumentEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string PublishEventDate: format: date-time description: Publish event date type: string PublishTo: format: date-time description: Publication valid to (inclusive) type: string PublishFrom: format: date-time description: Publication valid from (inclusive) type: string IsPublished: description: Publication is published type: boolean VisibleFor: description: The set of users or groups the record is visible for type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.VisibleFor' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EMailAddress: description: "Carrier object for EMailAddress.\r\nServices for the EMailAddress Carrier is available from the EMail Agent." type: object properties: ContactId: format: int32 description: Primary key type: integer ContactName: description: '' type: string PersonId: format: int32 description: Primary key type: integer PersonName: description: '' type: string AssociateId: format: int32 description: Primary key type: integer Address: description: '' type: string EmailId: format: int32 description: Primary key type: integer DuplicatePersonIds: description: All persons with this EmailAddress stored in db is listed here type: array items: format: int32 type: integer Name: description: The name on the email address type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EMailSOInfo: description: "Glue between SuperOffice data and an e-mail.\r\n\r\nCarrier object for EMailSOInfo.\r\nServices for the EMailSOInfo Carrier is available from the EMail Agent." type: object properties: DocumentId: format: int32 description: Primary key type: integer AppointmentId: format: int32 description: Primary key type: integer ProjectId: format: int32 description: Primary key type: integer SaleId: format: int32 description: Primary key type: integer Archived: description: Is this e-mail archived in SuperOffice type: boolean ArchivedAt: format: date-time description: The datetime when this email was archived type: string ArchivedBy: format: int32 description: The associate who archived this email type: integer ArchivedDisplayName: description: The full name of the associate who archived this email type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EMailAttachment: description: "Information about an attachment\r\n\r\nCarrier object for EMailAttachment.\r\nServices for the EMailAttachment Carrier is available from the EMail Agent." type: object properties: Description: description: Name/description type: string Filename: description: Filename type: string Size: format: int32 description: Size of attachment type: integer Type: description: Attachment Content-Type type: string Encoding: description: Content-Transfer-Encoding type: string Id: description: Content-ID type: string Disposition: description: Content-Disposition type: string IsSafeFileExtension: description: >- If the user should be allowed to download and perform other actions on the attachment. type: boolean Stream: format: byte description: >- Binary stream for outgoing attachments. This property will not be populated for existing e-mail items. type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EMailCustomHeader: description: "Carrier object for EMailCustomHeader.\r\nServices for the EMailCustomHeader Carrier is available from the EMail Agent." type: object properties: Name: description: Name of header type: string Values: description: '' type: array items: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.EMailEnvelope: description: "Limited information about one e-mail.\r\n\r\nCarrier object for EMailEnvelope.\r\nServices for the EMailEnvelope Carrier is available from the EMail Agent." type: object properties: ServerId: format: int32 description: Unique id for the e-mail on the server type: integer ServerIdentifier: description: Unique string id for the e-mail on the server (Graph API type: string MessageId: description: Unique id of e-mails type: string Subject: description: Subject of the e-mail type: string From: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' To: description: To recipients of e-mail type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailAddress' Sent: format: date-time description: When was the e-mail sent type: string Priority: description: Importance of the e-mail enum: - NoPriority - Highest - High - Normal - Low - Lowest type: string Flags: description: Flag status of this mail (unread, replied, deleted ) enum: - None - Seen - Deleted - Recent - Flagged - Draft - Answered type: string Size: format: int32 description: Total size of the e-mail type: integer EMailSOInfo: $ref: '#/components/schemas/SuperOffice.CRM.Services.EMailSOInfo' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.DocumentTemplate: description: "The template a document is based on is stored in the SO_arc\\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on.\r\n\r\nCarrier object for DocumentTemplate.\r\nServices for the DocumentTemplate Carrier is available from the List Agent." type: object properties: DocumentTemplateId: format: int32 description: Primary key type: integer Name: description: The list item type: string Tooltip: description: Tooltip or other description type: string SaveInDb: format: int32 description: 1 = save document records in DB; otherwise not. type: integer Filename: description: Relative to TemplatePath type: string DefaultOref: description: Processed via tag substitution to give document reference type: string RecordType: description: >- 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes enum: - Unknown - Appointment - Document - Email - Fax - Phone - Todo - MergeDraft - MergeFinal - SavedReport type: string Deleted: format: int32 description: >- 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists type: integer Direction: description: 1 = incoming, 2 = outgoing, see EAppntDirection enum: - Unknown - Incoming - Outgoing - SaintAll type: string AutoeventId: format: int32 description: >- Which document plugin is responsible for the documents generated from this template type: integer QuoteDocType: description: What type of quote document is this. enum: - None - MailBody - MainDocument - QuoteLines - ConfirmationMailBody - ConfirmationLines type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." type: object properties: Position: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonId: format: int32 description: Primary key type: integer Mrmrs: description: e.g. Mrs sex_title type: string Firstname: description: First name type: string Lastname: description: Last name type: string MiddleName: description: Middle name or 'van' etc. type: string Title: description: Title type: string Description: description: Info text/description on person. type: string Email: description: First email on contact person. type: string FullName: description: >- Get the persons full name (internal name used in clients for employees). type: string DirectPhone: description: Returns the direct phone that belong to the contact person. type: string FormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string CountryId: format: int32 description: Country type: integer ContactId: format: int32 description: Owning contact ID type: integer ContactName: description: The persons company name type: string Retired: format: int32 description: >- 1 = the user is retired and should have no rights, not appear in lists, etc. type: integer Rank: format: int32 description: Display sort sequence for default sort order type: integer ActiveInterests: format: int32 description: >- Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true type: integer ContactDepartment: description: The persons contact department type: string ContactCountryId: format: int32 description: The persons contact country id type: integer ContactOrgNr: description: The persons contact organization number type: string FaxPhone: description: Returns the fax phone that belong to the contact person. type: string MobilePhone: description: Returns the mobile phone that belong to the contact person. type: string ContactPhone: description: Returns the direct phone that belong to the persons contact. type: string AssociateName: description: Name of the person's owner type: string AssociateId: format: int32 description: Id of the item's owner (Associate id) type: integer UsePersonAddress: description: If 1, use person's address for mailing instead of company address type: boolean ContactFax: description: Actual phone number as eneterd by the user type: string Kanafname: description: Kana first name, used in Japanese versions only type: string Kanalname: description: Kana last name, used in Japanese versions only type: string Post1: description: Postal address, used in Japanese versions only type: string Post2: description: Postal address, used in Japanese versions only type: string Post3: description: Postal address, used in Japanese versions only type: string EmailName: description: E-mail description type: string ContactFullName: description: Company full name + department type: string ActiveErpLinks: format: int32 description: How many active ERP links are there for this person? type: integer TicketPriorityId: format: int32 description: Ticket priority ID type: integer SupportLanguageId: format: int32 description: Support priority ID type: integer SupportAssociateId: format: int32 description: Our support contact for this person type: integer CategoryName: description: The category list item name type: string PersonNumber: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Contact: description: "Carrier object for Contact.\r\nServices for the Contact Carrier is available from the Contact Agent." type: object properties: ContactId: format: int32 description: Primary key type: integer Name: description: Contact name type: string OrgNr: description: VAT number or similar type: string Department: description: Department type: string URL: description: The internet address to this contact type: string City: description: City corresponding to zip code type: string DirectPhone: description: The contacts phone type: string AssociateId: format: int32 description: Our contact type: integer CountryId: format: int32 description: Country type: integer EmailAddress: description: The contact email address type: string Kananame: description: Contact kana name, used in Japanese versions only type: string EmailAddressName: description: Visible field type: string URLName: description: Visible field type: string AssociateFullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string BusinessName: description: The business list item name type: string CategoryName: description: The category list item name type: string CountryName: description: Name of country in installed language type: string Address: $ref: '#/components/schemas/SuperOffice.CRM.Services.Address' FormattedAddress: description: >- The contact's address, formatted with linebreaks and spaces into a single string. type: string FullName: description: '' type: string IsOwnerContact: description: >- Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users. type: boolean ActiveErpLinks: format: int32 description: The number of active erp links type: integer Number1: description: Alphanumeric user field type: string Number2: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Project: description: "Carrier object for Project.\r\nServices for the Project Carrier is available from the Project Agent." type: object properties: ProjectId: format: int32 description: Primary key type: integer Name: description: Project name type: string Description: description: The projects description type: string URL: description: URL address type: string Type: description: The project type. type: string AssociateId: format: int32 description: The project owner id (associate id) type: integer AssociateFullName: description: The project owner type: string TypeId: format: int32 description: '' type: integer Updated: format: date-time description: Last updated date in UTC. type: string StatusId: format: int32 description: The projects status id type: integer Status: description: The projects status type: string TextId: format: int32 description: The id of the description type: integer PublishTo: format: date-time description: Publication valid to (inclusive) type: string PublishFrom: format: date-time description: Publication valid from (inclusive) type: string IsPublished: description: '' type: boolean URLName: description: Visible field type: string ProjectNumber: description: Automatically generated number type: string ActiveErpLinks: format: int32 description: The number of active erp links type: integer EventId: format: int32 description: Reserved field for Lyyti event when project is linked to an event. type: integer StartDate: format: date-time description: >- Reserved field for Lyyti event when project is linked to an event, is the event start date. type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Link: description: "Links two entities (contacts/projects/sales/URLs) together.\r\n\r\nCarrier object for Link.\r\nServices for the Link Carrier is available from the List Agent." type: object properties: EntityName: description: >- Name of the entity the link points to (The destination/target entity) type: string Id: format: int32 description: >- Id of the entity the link points to (The destination/target entity primary key) type: integer Description: description: Link description. type: string ExtraInfo: description: >- Extrainfo for link. Use for information that does not have a primary key type: string LinkId: format: int32 description: Primary key type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Sale: description: "Carrier object for Sale.\r\nServices for the Sale Carrier is available from the Sale Agent." type: object properties: ContactName: description: Contact name type: string SaleDate: format: date-time description: (expected / lost / won) sales date type: string SaleId: format: int32 description: Primary key type: integer Probability: format: int32 description: Actual probability, may differ from the one in the list type: integer Title: description: Sale heading (short description?) type: string Amount: format: double description: Total sale amount type: number Currency: description: Currency the sale was made in. type: string ProjectName: description: Project name type: string AssociateFullName: description: The sale's owner type: string Description: description: The sales description type: string Status: description: The sale's status, indicating wether the sale is open, sold or lost. enum: - Unknown - Open - Sold - Lost - Stalled - SaintAll type: string WeightedAmount: format: double description: The weighted amount ( amount * probability / 100) type: number ProjectId: format: int32 description: Optional project reference type: integer EarningPercent: format: double description: Earning as percent of total type: number Earning: format: double description: Earning on sale type: number ContactId: format: int32 description: Optional contact reference type: integer AssociateId: format: int32 description: The sale's owner id type: integer PersonId: format: int32 description: The sale's contact persons id type: integer SaleTypeId: format: int32 description: The sale's type id type: integer SaleTypeName: description: The sale's type name type: string PersonFullName: description: The name of the person this sale belongs to. type: string Completed: description: >- The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field. enum: - Unknown - NotStarted - Started - Completed type: string ActiveErpLinks: format: int32 description: The number of active erp links type: integer NextDueDate: format: date-time description: >- Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching. type: string Number: description: Alphanumeric user field type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.VisibleFor: description: "Carrier object for VisibleFor.\r\nServices for the VisibleFor Carrier is available from the Sentry Agent." type: object properties: VisibleId: format: int32 description: '' type: integer Visibility: description: '' enum: - All - Associate - Group type: string DisplayValue: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Services.Address: description: "Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered.\r\n\r\nCarrier object for Address." type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField' Street: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Postal: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: "Postboks 123,\nBrugata 123,\n1234 OSLO\n" or "Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n". type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.LocalizedField: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.StructuredAddress: description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n\r\nCarrier object for StructuredAddress." type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: "Brugata 123,\n1234 OSLO\n" or "Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n". type: string ```` ## Related topics - [SuperOffice.WebApi.Data.EMail CreateEMailFromDocumentEntityRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.EMail_CreateEMailFromDocumentEntityRequest.md) - [SuperOffice.WebApi.Agents.EMailAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.EMailAgent.md) - [SuperOffice.WebApi.Agents.IEMailAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IEMailAgent.md) - [Create New Physical Mail Merge Document From Template](/en/api/reference/restful/agent/document_agent/create-new-physical-mail-merge-document-from-template.md) - [NSDocumentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDocumentAgent.md) - [Create Default Document Template Entity](/en/api/reference/restful/rest/list_documenttemplate/create-default-document-template-entity.md)