### GET /LeanLeadAttachmentFolderCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-attachment Retrieves the collection of lead attachments. ```APIDOC ## GET /LeanLeadAttachmentFolderCollection ### Description Retrieves information about existing attached documents in the Leads. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeanLeadAttachmentFolderCollection ### Response #### Success Response (200) - **Binary** (Edm.String) - Binary data reference - **CatagoryCode** (Edm.String) - Category code - **CatagoryCodeText** (Edm.String) - Category code description - **CreatedBy** (Edm.String) - User who created the attachment - **CreatedOn** (Edm.DateTime) - Creation timestamp - **DocumentLink** (Edm.String) - Link to the document - **LastUpdatedBy** (Edm.String) - User who last updated the attachment - **LastUpdatedOn** (Edm.DateTime) - Last update timestamp - **LinkWebURL** (Edm.String) - Web URL link - **MimeType** (Edm.String) - MIME type of the document - **Name** (Edm.String) - Name of the attachment - **ObjectID** (Edm.String) - Object ID - **PrimaryObjectID** (Edm.String) - Primary Object ID - **TypeCode** (Edm.String) - Type code - **TypeCodeText** (Edm.String) - Type code description - **UUID** (Edm.Guid) - Unique identifier ``` -------------------------------- ### GET LeadCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead Retrieves the collection of leads from the SAP Cloud for Customer system. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/LeadCollection ### Description Retrieves the Lead collection (LeanLead), which represents individuals or organizations that a company has the potential to do business with. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeadCollection ### Attributes - **ID** (Edm.String) - Lead identifier - **Category** (Edm.String) - Lead category code - **Source** (Edm.String) - Lead origin type code - **Priority** (Edm.String) - Lead priority code - **End Date** (Edm.DateTime) - Lead end date - **Start Date** (Edm.DateTime) - Lead start date - **Processing Type** (Edm.String) - Processing type code - **Qualification Level** (Edm.String) - Qualification level code - **Reason Code** (Edm.String) - Result reason code - **Approval Status** (Edm.String) - Approval status code - **Consistency Status** (Edm.String) - Consistency status code - **Survey Score** (Edm.Int) - Total survey score value - **Creation Date Time** (Edm.DateTimeOffset) - Creation timestamp - **Expected Revenue Value** (Edm.Decimal) - Expected revenue amount - **Name** (Edm.String) - Lead name ``` -------------------------------- ### GET ProductChangedBy Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/product-changedby Retrieves information about the Business Partner who recently changed a product. ```APIDOC ## GET ProductChangedBy ### Description Retrieves the Business Partner details associated with the most recent change to a product. This is a read-only entity. ### Method GET ### Properties - **BusinessPartnerFormattedName** (Edm.String) - The formatted name of the business partner. - **ObjectID** (Edm.String) - The unique identifier for the object. ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codata/LeanLeadExternalPartyCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-involved-parties Retrieves the collection of involved parties associated with leads. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/LeanLeadExternalPartyCollection ### Description Retrieves a list of involved parties for leads. This collection contains details such as contact information, party roles, and links to the parent LeanLead object. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeanLeadExternalPartyCollection ### Properties - **EMail** (Edm.String) - Nullable: true, Max Length: 765 - **Mobile** (Edm.String) - Nullable: true, Max Length: 350 - **PartyName** (Edm.String) - Nullable: true, Max Length: 480 - **ObjectID** (Edm.String) - Nullable: false, Max Length: 70 - **ParentObjectID** (Edm.String) - Nullable: true, Max Length: 70 - **PartyID** (Edm.String) - Nullable: true, Max Length: 60 - **PartyUUID** (Edm.String) - Nullable: true - **Phone** (Edm.String) - Nullable: true, Max Length: 350 - **MainIndicator** (Edm.String) - Nullable: true - **MainPartyContactPartyID** (Edm.String) - Nullable: true, Max Length: 60 - **MainPartyContactPartyName** (Edm.String) - Nullable: true - **MainPartyContactPartyUUID** (Edm.String) - Nullable: true - **RoleCode** (Edm.String) - Nullable: true, Max Length: 10 ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codataapi/$metadata Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/odata-api-v2-reference Retrieves the metadata document for the OData API of the tenant. ```APIDOC ## GET /sap/c4c/odata/v1/c4codataapi/$metadata ### Description Retrieves the metadata definition for the OData API, which describes the structure of the available business objects and collections. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codataapi/$metadata ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codata/ProductCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/product Retrieves the collection of products from the SAP Cloud for Customer OData service. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/ProductCollection ### Description Retrieves a collection of products, which are articles or substances manufactured or refined for sale. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/ProductCollection ### Properties - **ChangedOn** (Edm.DateTimeOffset) - Last change timestamp - **CreatedBy** (Edm.String) - User who created the product - **CreatedOn** (Edm.DateTimeOffset) - Creation timestamp - **Description** (Edm.String) - Product description - **LanguageCode** (Edm.String) - Language code - **ID** (Edm.String) - Product ID - **ObjectID** (Edm.String) - Unique object identifier - **StatusCode** (Edm.String) - Product status code - **UUID** (Edm.Guid) - Unique identifier - **UnitOfMeasureCode** (Edm.String) - Unit of measure code ### Navigations - **ProductAttachment** (1..*) - **ProductCategoryAssignment** (1..*) - **ProductChangedBy** (1..*) - **ProductSales** (1..*) ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codata/EmployeeCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/employee Retrieves the collection of employees from the organization. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/EmployeeCollection ### Description Retrieves a list of internal and external employees associated with the organization. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/EmployeeCollection ### Properties - **AcademicTitleCode** (Edm.String) - Academic title code. - **EmployeeID** (Edm.String) - Unique identifier for the employee. - **FirstName** (Edm.String) - Employee first name. - **LastName** (Edm.String) - Employee last name. - **InternalEmployeeIndicator** (Edm.Boolean) - Indicates if the employee is internal. - **InternalID** (Edm.String) - Internal identifier. - **Name** (Edm.String) - Full name of the employee. - **ObjectID** (Edm.String) - Unique object identifier. - **StartDate** (Edm.DateTime) - Start date of the employee record. - **EndDate** (Edm.DateTime) - End date of the employee record. - **UserID** (Edm.String) - User identifier. - **UUID** (Edm.Guid) - Universally unique identifier. ``` -------------------------------- ### GET AccountCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/account Retrieves the collection of corporate customers and prospects. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/AccountCollection ### Description Retrieves a list of corporate customers and prospects from the Account collection. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/AccountCollection ### Response #### Success Response (200) - **AccountID** (Edm.String) - Unique identifier for the account. - **AccountName** (Edm.String) - Name of the account. - **AccountFormattedName** (Edm.String) - Formatted name of the account. - **CatagoryCode** (Edm.String) - Category code of the account. - **ObjectID** (Edm.String) - Unique object identifier. - **PrimaryContactName** (Edm.String) - Name of the primary contact. ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codataapi Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/sap-cloud-for-customer-odata-api Access the base OData API for your SAP Cloud for Customer tenant. ```APIDOC ## GET /sap/c4c/odata/v1/c4codataapi ### Description Access the SAP Cloud for Customer OData API of your tenant. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codataapi ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codata/TaskCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/task Retrieves the collection of tasks within the organization. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/TaskCollection ### Description Retrieves a list of all business-relevant tasks that employees need to address within a specified timeframe. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/TaskCollection ### Response #### Success Response (200) - **Account** (c4codata.ENCRYPTED_LONG_Name) - Account name associated with the task - **AccountID** (Edm.String) - ID of the account - **AccountUUID** (Edm.Guid) - UUID of the account - **CatagoryCode** (Edm.String) - Category code of the task - **CatagoryCodeText** (Edm.String) - Description of the category code - **CompletionDateTime** (Edm.DateTimeOffset) - Date and time of task completion - **CompletionPercent** (Edm.Decimal) - Percentage of task completion - **DueDataTime** (c4codata.LOCALNORMALISED_DateTime) - Due date and time - **ID** (Edm.Guid) - Unique identifier for the task - **ObjectID** (Edm.String) - Object ID of the task - **Owner** (c4codata.ENCRYPTED_LONG_Name) - Owner of the task - **OwnerUUID** (Edm.Guid) - UUID of the owner - **PrimaryContact** (c4codata.ENCRYPTED_LONG_Name) - Primary contact name - **PrimaryContactID** (Edm.String) - Primary contact ID - **PrimaryContactUUID** (Edm.Guid) - Primary contact UUID - **PriorityCode** (Edm.String) - Priority code - **PriorityCodeText** (Edm.String) - Description of the priority code - **Processor** (c4codata.ENCRYPTED_LONG_Name) - Processor name - **ProcessorID** (Edm.String) - Processor ID - **ProcessorUUID** (Edm.Guid) - Processor UUID - **StartDateTime** (c4codata.LOCALNORMALISED_DateTime) - Start date and time - **StatusCode** (Edm.String) - Status code - **StatusCodeText** (Edm.String) - Description of the status code - **Subject** (Edm.String) - Subject of the task - **TypeCode** (Edm.String) - Type code - **ReportedDateTime** (Edm.DateTimeOffset) - Date and time the task was reported - **TypeCodeText** (Edm.String) - Description of the type code ``` -------------------------------- ### GET LeanLeadBusinessTransactionDocumentReference Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-business-document-relationship Retrieves the collection of business document references associated with leads. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/LeanLeadBusinessTransactionDocumentReference ### Description Retrieves the LeanLeadBusinessTransactionDocumentReference collection, which contains information about business document references for leads. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeanLeadBusinessTransactionDocumentReference ### Properties - **ObjectID** (Edm.String) - Required - Unique identifier of the object. - **ParentObjectID** (Edm.String) - Optional - Identifier of the parent object. - **ID** (Edm.String) - Optional - Document ID. - **TypeCode** (Edm.String) - Optional - Type code of the document. - **UUID** (Edm.String) - Optional - Universally unique identifier. - **ItemID** (Edm.String) - Optional - Item identifier. - **ItemTypeCode** (Edm.String) - Optional - Item type code. - **ItemUUID** (Edm.Guid) - Optional - Item UUID. - **BusinessTransactionDocumentRelationshipRoleCode** (Edm.String) - Optional - Role code for the business transaction document relationship. ``` -------------------------------- ### GET /LeanLeadSalesAndMarketingTeamCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-sales-and-marketing-team Retrieves the collection of sales and marketing team members associated with leads. ```APIDOC ## GET /LeanLeadSalesAndMarketingTeamCollection ### Description Retrieves the collection of sales and marketing team members associated with leads. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeanLeadSalesAndMarketingTeamCollection ### Response #### Success Response (200) - **EMail** (Edm.String) - Email address of the team member - **Mobile** (Edm.String) - Mobile phone number - **PartyName** (Edm.String) - Name of the party - **ObjectID** (Edm.String) - Unique identifier of the record - **ParentObjectID** (Edm.String) - Unique identifier of the parent lead - **PartyID** (Edm.String) - ID of the party - **PartyUUID** (Edm.Guidt) - UUID of the party - **Phone** (Edm.String) - Phone number - **MainIndicator** (Edm.String) - Indicator for main team member - **RoleCode** (Edm.String) - Role code of the team member ``` -------------------------------- ### GET /UserCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/user Retrieves the collection of user details from the SAP Cloud for Customer system. ```APIDOC ## GET /UserCollection ### Description Retrieves a list of user records containing detailed information such as IDs, status, and account settings. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/UserCollection ### Response #### Success Response (200) - **ChangedBy** (Edm.String) - User who last changed the record - **ChangedByUUID** (Edm.Guid) - UUID of the user who last changed the record - **ChangedOn** (Edm.DateTimeOffset) - Timestamp of the last change - **CreatedBy** (Edm.String) - User who created the record - **CreatedByUUID** (Edm.Guid) - UUID of the user who created the record - **CreatedOn** (Edm.DateTimeOffset) - Timestamp of creation - **DateFormatCode** (Edm.String) - Date format code - **DecimalFormatCode** (Edm.String) - Decimal format code - **EmployeeID** (Edm.String) - Employee ID - **EmployeeUUID** (Edm.Guid) - Employee UUID - **InactiveIndicator** (Edm.Boolean) - Indicates if the user is inactive - **LogonLanguageCode** (Edm.String) - Logon language code - **ObjectID** (Edm.String) - Unique object ID - **PasswordInactiveIndicator** (Edm.Boolean) - Indicates if the password is inactive - **PasswordLockedIndicator** (Edm.Boolean) - Indicates if the password is locked - **PasswordPolicyCode** (Edm.String) - Password policy code - **StatusCode** (Edm.String) - User status code - **TimeFormatCode** (Edm.String) - Time format code - **TimeZoneCode** (Edm.String) - Time zone code - **TitleCode** (Edm.String) - Title code - **UUID** (Edm.Guid) - Unique user UUID - **UserID** (Edm.String) - User ID - **UserAccountID** (Edm.String) - User account ID - **UserAccountTypeCode** (Edm.String) - User account type code - **Username** (Edm.String) - Username ``` -------------------------------- ### GET Codelist Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/codelist Retrieves the list of codes and their descriptions. This is a read-only entity that cannot be created, updated, or deleted. ```APIDOC ## GET Codelist ### Description Retrieves a collection of codes and their corresponding descriptions. This entity is read-only and automatically included in service metadata if properties representing a code type exist. ### Method GET ### Properties - **Code** (Edm.String) - The code value. - **Description** (Edm.String) - The description associated with the code. ``` -------------------------------- ### GET /sap/c4c/odata/v1/c4codata/LeanLeadContactCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-contact Retrieves the collection of contacts related to leads. This collection is read-only and cannot be created via OData. ```APIDOC ## GET /sap/c4c/odata/v1/c4codata/LeanLeadContactCollection ### Description Retrieves the LeanLeadContactCollection, which provides information about all contacts related to an account of a lead. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/LeanLeadContactCollection ### Properties - **PartyID** (Edm.String) - Required - Unique identifier for the party. - **PartyUUID** (Edm.UUID) - Optional - UUID of the party. - **EMail** (Edm.String) - Optional - Email address of the contact. - **Mobile** (Edm.DateTime) - Optional - Mobile phone number. - **PartyName** (Edm.String) - Optional - Name of the party. - **ObjectID** (Edm.DateTime) - Optional - Object identifier. - **Phone** (Edm.String) - Optional - Phone number. - **MainIndicator** (Edm.Boolean) - Optional - Indicates if this is the main contact. ### Navigations - **LeanLead** (LeanLead) - Navigates to the parent LeanLead entity. ``` -------------------------------- ### GET https:///sap/c4c/odata/v1/c4codata/EmailCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/email Retrieves the collection of email communications. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/EmailCollection ### Description Retrieves the collection of email communications associated with business partners and related objects. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/EmailCollection ### Properties - **AccountID** (Edm.String) - Account identifier - **AccountName** (c4codata.ENCRYPTED_LONG_Name) - Account name - **AccountUUID** (Edm.Guid) - Account UUID - **DateTime** (c4codata.LOCALNORMALISED_DateTime) - Date and time of the email - **GroupCode** (Edm.String) - Group code - **GroupCodeText** (Edm.String) - Group code description - **ID** (Edm.Guid) - Email identifier - **MessageFromPartyID** (Edm.DateTime) - Sender party ID - **MessageFromPartyName** (c4codata.ENCRYPTED_LONG_Name) - Sender party name - **MessageFromPartyUUID** (Edm.Guide) - Sender party UUID - **ObjectID** (Edm.String) - Object identifier - **OwnerName** (c4codata.ENCRYPTED_LONG_Name) - Owner name - **PriorityCode** (Edm.String) - Priority code - **PriorityCodeText** (Edm.Guid) - Priority code description - **StatusCode** (Edm.String) - Status code - **StatusCodeText** (Edm.String) - Status code description - **SubjectName** (Edm.String) - Email subject - **TypeCode** (Edm.String) - Type code - **TypeCodeText** (Edm.String) - Type code description - **CorrespondenceTransmissionStatusCode** (Edm String) - Transmission status code - **MessageFromEmailURI** (Edm String) - Sender email URI - **MessageFromName** (Edm String) - Sender name - **UUID** (Edm Guid) - Email UUID ``` -------------------------------- ### GET ContextualCodeList Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/contextual-codelist Retrieves a collection of contextual codes. Filtering by the 'Context' parameter is supported to narrow results. ```APIDOC ## GET /ContextualCodeList ### Description Retrieves a list of contextual codes and their descriptions. The entity set is read-only. ### Method GET ### Endpoint /ContextualCodeList ### Parameters #### Query Parameters - **$filter** (string) - Optional - Filter by 'Context' to retrieve codes relevant to a specific context (e.g., Context eq 'US'). ### Response #### Success Response (200) - **Code** (Edm.String) - The code value. - **Context** (Edm.String) - The context for which the code is relevant. - **Description** (Edm.String) - The description of the code. ``` -------------------------------- ### GET AppointmentCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/appointment Retrieves the collection of appointments from the SAP Cloud for Customer OData service. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/AppointmentCollection ### Description Retrieves a list of appointments available in the system. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/AppointmentCollection ### Response #### Success Response (200) - **Account** (c4codata.ENCRYPTED_LONG_Name) - Account associated with the appointment - **AccountID** (Edm.String) - ID of the account - **AllDayEvent** (Edm.Boolean) - Indicates if the appointment is an all-day event - **ID** (Edm.String) - Unique identifier for the appointment - **StartDateTime** (Edm.DateTimeOffset) - Start date and time of the appointment - **EndDateTime** (c4codata.LOCALNORMALISED_DateTime) - End date and time of the appointment - **Subject** (Edm.String) - Subject of the appointment - **StatusCode** (Edm.String) - Status code of the appointment ``` -------------------------------- ### GET AccountSalesOfficeName Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/accountsalesofficename Retrieves the list of Sales group names from the AccountSalesData entity. ```APIDOC ## GET AccountSalesOfficeName ### Description Retrieves the collection of all Sales group names present in the AccountSalesData entity type. ### Properties - **Name** (Edm.String) - Nullable: TRUE, Max Length: 40, Fixed length: TRUE - **ObjectID** (Edm.String) - Nullable: TRUE, Max Length: 70, Fixed length: TRUE ``` -------------------------------- ### GET https:///sap/c4c/odata/v1/c4codata/ContactCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/contact Retrieves the collection of contacts from the SAP Cloud for Customer system. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/ContactCollection ### Description Retrieves the contact information of accounts. Contacts can be related to multiple accounts or a single account. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/ContactCollection ### Properties - **CreationOn** (Edm.DateTime) - Creation timestamp - **ChangedOn** (Edm.DateTime) - Last change timestamp - **CreatedBy** (Edm.String) - User who created the contact - **ChangedBy** (Edm.String) - User who last changed the contact - **RoleCode** (Edm.String) - Role code of the contact - **StartDate** (Edm.DateTime) - Start date of the contact relationship - **EndDate** (Edm.DateTime) - End date of the contact relationship - **ObjectID** (Edm.String) - Unique object identifier - **ContactName** (Edm.String) - Full name of the contact - **UUID** (Edm.Guid) - Unique identifier - **ContactID** (Edm.String) - Contact ID - **FirstName** (Edm.String) - First name - **MiddleName** (Edm.String) - Middle name - **LastName** (Edm.String) - Last name - **AccountID** (Edm.String) - Associated Account ID - **AccountUUID** (Edm.Guid) - Associated Account UUID - **AccountName** (Edm.String) - Associated Account Name - **NickName** (Edm.String) - Nickname - **MarketingLeadIndicator** (Edm.Boolean) - Marketing lead indicator ### Navigations - **ContactAttachment** (Contact -> ContactAttachment) - 1..* - **ContactNotes** (Contact -> ContactNotes) - 1..* - **ContactBusinessAddress** (Contact -> ContactBusinessAddress) - 1..1 - **ContactCommunicationData** (Contact -> ContactCommunicationData) - 1..* - **ContactPersonalAddress** (Contact -> ContactPersonalAddress) - 0..* ``` -------------------------------- ### GET /PhoneCallCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/phone-call Retrieves the collection of phone call records from the SAP Cloud for Customer OData service. ```APIDOC ## GET https:///sap/c4c/odata/v1/c4codata/PhoneCallCollection ### Description Retrieves a list of phone call records. This collection allows you to track and document phone calls with business partners. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/c4codata/PhoneCallCollection ### Properties - **AccountFormattedName** (c4codata.ENCRYPTED_LONG_Name) - Account name associated with the call. - **AccountUUID** (Edm.Guid) - Unique identifier for the account. - **CampaignDescription** (c4codata.MEDIUM_Description) - Description of the associated campaign. - **CampaignUUID** (Edm.Guid) - Unique identifier for the campaign. - **CatagoryCode** (Edm.String) - Category code of the call. - **CreatedOn** (Edm.DateTimeOffset) - Timestamp when the record was created. - **DateTime** (c4codata.LOCALNORMALISED_DateTime) - Date and time of the phone call. - **DirectionCode** (Edm.String) - Code indicating if the call was inbound or outbound. - **ID** (Edm.String) - Unique ID of the phone call. - **ObjectID** (Edm.String) - Internal object identifier. - **OwnerUUID** (Edm.Guid) - Unique identifier for the owner of the record. - **Phone** (Edm.String) - Phone number associated with the call. - **PriorityCode** (Edm.String) - Priority level of the call. - **StatusCode** (Edm.String) - Current status of the call. - **SubjectName** (Edm.String) - Subject or title of the phone call. ### Navigations - **PhoneCallNotes** (1..*) - Related notes for the phone call. - **PhoneCallParticipants** (1..*) - Participants involved in the phone call. - **PhoneCallAttachment** (1..*) - Attachments associated with the phone call. ``` -------------------------------- ### GET /sap/c4c/odata/v1/changedoclist/ChangeDocumentCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/odata-service-for-change-documents Retrieves change document data for business object instances based on provided filter criteria. ```APIDOC ## GET /sap/c4c/odata/v1/changedoclist/ChangeDocumentCollection ### Description Retrieves change document data for business object instances. The service supports filtering by BusinessObject, ChangeDateTime, and ObjectUUID, as well as standard OData $top and $skip parameters. ### Method GET ### Endpoint https:///sap/c4c/odata/v1/changedoclist/ChangeDocumentCollection ### Parameters #### Query Parameters - **$filter** (string) - Required - Filter expression including 'BusinessObject' (Mandatory), 'ChangeDateTime' (Optional), and 'ObjectUUID' (Optional). - **$top** (integer) - Optional - Standard OData parameter for paging. - **$skip** (integer) - Optional - Standard OData parameter for paging. ### Response #### Success Response (200) - **ID** (string) - Change document ID - **BusinessObjectName** (string) - Name of the business object - **ObjectUUID** (string) - UUID of the object - **ChangeDateTime** (datetime) - Timestamp of the change - **ChangedByIdentityUUID** (string) - UUID of the user who made the change - **ChangedByUserName** (string) - Name of the user who made the change - **ObjectNodeElementName** (string) - Name of the changed element - **ObjectNodeElementOldContent** (string) - Previous value of the element - **ObjectNodeElementNewContent** (string) - New value of the element ``` -------------------------------- ### OData Notification JSON Payload Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/deprecated-setting-up-odata-notifications Example of the JSON structure sent to external consumers when a business object event occurs. ```json {"businessObject":"CUSTOMER","businessObjectId":"00163E08BFEC1ED785AE497656AA26FE","odataServiceEndpoint":"https://my123456.ondemend.com/sap/byd/odata/v1/c4codata/AccountCollection('00163E08BFEC1ED785AE497656AAXXXX')","event":"create"}] ``` -------------------------------- ### GET ExternalIDMapping Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/external-id-mapping Retrieves the mapping details of a local object identifier corresponding to an object identifier in a remote system. ```APIDOC ## GET ExternalIDMapping ### Description Retrieves a collection of external ID mappings. This is a read-only entity. ### Method GET ### Endpoint /ExternalIDMapping ### Response #### Success Response (200) - **ExternalID** (Edm.String) - Local object identifier - **ExtneralSystemID** (Edm.String) - Identifier of the external system - **ExternalSystemUUID** (Edm.Guid) - UUID of the external system - **ObjectID** (Edm.String) - Object identifier - **ObjectTypeCode** (Edm.String) - Code for the object type - **ObjectTypeCodeText** (Edm.String) - Description of the object type code ``` -------------------------------- ### Supported System Query Options Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/sap-cloud-for-customer-odata-api?locale=en-US&state=PRODUCTION&version=CLOUD The API supports standard OData V2 query parameters for data manipulation and retrieval. ```APIDOC ## Supported System Query Options The SAP Cloud for Customer OData API supports the following OData V2 system query options: - **$count**: Returns the count of entities. - **$expand**: Expands related entities. - **$filter**: Filters the result set. - **$format**: Specifies the response format. - **$inlinecount**: Includes the total count of entities in the response. - **$orderby**: Sorts the result set. - **$search**: Performs a full-text search. - **$select**: Selects specific properties. - **$skip**: Skips a number of entities. - **$skiptoken**: Used for server-side paging. - **$top**: Limits the number of entities returned. ``` -------------------------------- ### OpportunityAppointmentSalesActivity Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/opportunity-appointment-sales-activity The OpportunityAppointmentSalesActivity collection represents sales activities created to follow up on opportunities. It includes properties for tracking activity status, owner, and timing. ```APIDOC ## OpportunityAppointmentSalesActivity Entity ### Description Provides information about sales activities (Appointments, Tasks, PhoneCalls, E-mails) related to opportunities. ### Properties - **DueDateTime** (c4codata.LOCALNORMALISED_DateTime) - Due date and time of the activity. - **ID** (Edm.String) - Unique identifier of the activity. - **ObjectID** (Edm.String) - Object identifier. - **OwnerID** (Edm.String) - Identifier of the owner. - **OwnerName** (c4codata.ENCRYPTED_LONG_Name) - Name of the owner. - **OwnerUUID** (Edm.Guid) - UUID of the owner. - **ParentObjectD** (Edm.String) - Identifier of the parent object. - **SalesPhaseCode** (Edm.String) - Code for the sales phase. - **SalesPhaseCodeText** (Edm.String) - Description of the sales phase. - **StartDateTime** (Edm.DateTimeOffset) - Start date and time of the activity. - **StatusCode** (Edm.String) - Status code of the activity. - **StatusCodeText** (Edm.String) - Description of the status. - **Subject** (Edm.String) - Subject of the activity. - **TypeCode** (Edm.String) - Type code of the activity. - **TypeCodeText** (Edm.String) - Description of the activity type. - **UUID** (Edm.Guid) - Unique identifier (UUID) of the activity. ### Navigations - **Opportunity** (OpportunityAppointmentSalesActivity -> Opportunity) - Cardinality: 1..* ``` -------------------------------- ### Compatibility Mode Header Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/compatibility-mode-for-read-operations Use the odata-v2-strict-json-format header to enable strict OData V2 JSON formatting for READ and Expand operations. ```APIDOC ## HTTP Header: odata-v2-strict-json-format ### Description Enables strict OData V2 protocol compatibility for READ operations. When set to 'true', the response payload includes a 'results' tag for READ operations with a key and for Expand operations involving NavigationProperties with 'many' cardinality. ### Usage Include this header in your HTTP request to ensure compatibility with third-party tools requiring strict OData V2 adherence. ### Header - **odata-v2-strict-json-format** (boolean) - Required - Set to 'true' to enable compatibility mode. ``` -------------------------------- ### LeanLeadItem Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/lead-product The LeanLeadItem collection provides information about products associated with Leads. ```APIDOC ## LeanLeadItem Entity ### Description The LeanLeadItem collection provides information about products in the Leads. ### Properties - **ProductCategoryDescription** (Edm.String) - Nullable: true, Max Length: 80 - **ProductCategoryInternalID** (Edm.String) - Nullable: true, Max Length: 20, Fixed Length: true - **Description** (Edm.String) - Nullable: true, Max Length: 40 - **ID** (Edm.String) - Nullable: true, Max Length: 10, Fixed Length: true - **ObjectID** (Edm.String) - Nullable: true, Max Length: 70, Fixed Length: true - **ParentObjectID** (Edm.String) - Nullable: true, Max Length: 70, Fixed Length: true - **ProductID** (Edm.String) - Nullable: true, Max Length: 60 - **Quantity** (Edm.Decimal) - Nullable: true, Max Length: 31 - **unitCode** (Edm.String) - Nullable: true, Max Length: 3 ### Navigations - **LeanLead** (From: LeanLeadItem, To: LeanLead, Cardinality: 1..1) ``` -------------------------------- ### IndividualCustomerCollection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/individual-customer Access the Individual Customer collection to manage customer data. ```APIDOC ## IndividualCustomerCollection ### Description The Individual Customer collection provides information about customers who are not associated with a corporate account. This collection supports creating, updating, and viewing individual customer records. ### Endpoint https:///sap/c4c/odata/v1/c4codata/IndividualCustomerCollection ### Properties - **ABCClassificationCode** (Edm.String) - ABC Classification Code - **AcademicTitleCode** (Edm.String) - Academic Title Code - **CustomerID** (Edm.String) - Unique Customer Identifier - **DateOfBirth** (Edm.DateTime) - Date of Birth - **EMail** (Edm.String) - Email Address - **FirstName** (Edm.String) - First Name - **LastName** (Edm.String) - Last Name (Required) - **GenderCode** (Edm.String) - Gender Code - **Mobile** (Edm.String) - Mobile Phone Number - **Phone** (Edm.String) - Phone Number - **StreetName** (Edm.String) - Street Name - **UUID** (Edm.String) - Unique Identifier ``` -------------------------------- ### EMailToRecipients Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/email-to-recipients Details regarding the EMailToRecipients collection, its properties, and navigation paths. ```APIDOC ## EMailToRecipients ### Description The EMailToRecipients collection provides information about all “To” Recipients in E-mail. ### Properties - **Address** (Edm.String) - Nullable: true, Max Length: 480 - **EMailID** (Edm.String) - Nullable: true, Max Length: 765 - **Name** (c4codata.ENCRYPTED_LONG_Name) - Nullable: true - **ObjectID** (Edm.String) - Nullable: false, Max Length: 70 - **ParentObjectID** (Edm.String) - Nullable: true, Max Length: 70 - **PartyID** (Edm.String) - Nullable: true, Max Length: 60 - **PartyUUID** (Edm.Guid) - Nullable: true - **Phone** (Edm.DateTime) - Nullable: true, Max Length: 350 - **RoleCategoryCode** (Edm.String) - Nullable: true, Max Length: 3 - **MessageToEmailID** (Edm.String) - Nullable: true, Max Length: 254 - **MessageToName** (Edm.String) - Nullable: true, Max Length: 255 - **RoleCategoryCodeText** (Edm.String) - Nullable: true ### Navigations - **EMail** (Cardinality: * .. 1) - Navigates to the parent EMail entity. ``` -------------------------------- ### ProductSalesOrganisation Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/product-sales-organisation The ProductSalesOrganisation collection provides the Sales Organization Information ID of their corresponding Product. ```APIDOC ## ProductSalesOrganisation ### Description The ProductSalesOrganisation collection provides the Sales Organization Information ID of their corresponding Product. ### Properties - **ObjectID** (Edm.String) - Nullable: true, Max Length: 70, Fixed length: true ``` -------------------------------- ### IndividualCustomerAttachment Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/individual-customer-attachment The IndividualCustomerAttachment entity represents files or links attached to an individual customer record. It includes metadata such as binary content, MIME type, and creation details. ```APIDOC ## IndividualCustomerAttachment Entity ### Description The IndividualCustomerAttachment entity stores information about attachments linked to an IndividualCustomer. It supports CRUD operations for managing customer-related documents. ### Properties - **Binary** (Edm.Binary) - Binary content of the attachment. - **CategoryCode** (Edm.String) - Required - Category code of the attachment. - **CategoryCodeText** (Edm.String) - Text description of the category code. - **CreatedBy** (Edm.String) - User who created the attachment. - **CreatedOn** (Edm.DateTime) - Timestamp of creation. - **DocumentLink** (Edm.String) - URL or link to the document. - **LastUpdatedBy** (Edm.String) - User who last updated the attachment. - **LastUpdatedOn** (Edm.DateTime) - Timestamp of the last update. - **LinkWebURI** (Edm.String) - Web URI for the attachment. - **MimeType** (Edm.String) - MIME type of the file. - **Name** (Edm.String) - Name of the attachment. - **ObjectID** (Edm.String) - Unique identifier for the attachment object. - **ParentObjectID** (Edm.String) - Identifier of the parent IndividualCustomer. - **TypeCode** (Edm.String) - Type code of the attachment. - **TypeCodeText** (Edm.String) - Text description of the type code. - **UUID** (Edm.String) - Required - Unique identifier for the entity. ``` -------------------------------- ### OpportunityNotes Entity Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/opportunity-notes The OpportunityNotes collection provides access to text entries linked to an Opportunity. It includes properties for text content, author information, and timestamps. ```APIDOC ## OpportunityNotes Entity ### Description The OpportunityNotes collection provides information about all the text collections or the notes related to an Opportunity. ### Properties - **ParentObjectID** (Edm.String) - The ID of the parent Opportunity. - **ObjectID** (Edm.String) - The unique identifier for the note. - **TypeCode** (Edm.String) - The type of text (e.g., internal comments, shipping instructions). - **LanguageCode** (Edm.String) - The language code of the text. - **Text** (Edm.String) - The actual content of the note. - **CreatedOn** (Edm.DateTime) - Timestamp when the note was created. - **UpdatedOn** (Edm.DateTime) - Timestamp when the note was last updated. - **CreatedBy** (Edm.DateTime) - User who created the note. - **LastUpdatedBy** (Edm.String) - User who last updated the note. - **AuthorName** (Edm.String) - Name of the author. - **AuthorUUID** (Edm.Guid) - Unique identifier of the author. - **LanguageCodeText** (Edm.String) - The language description. ``` -------------------------------- ### VisitText Collection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/visit-text The VisitText collection provides access to text and note entities related to the Visit top-level entity. ```APIDOC ## VisitText Collection ### Description Provides information about notes entered during site visits. ### Properties - **AuthorName** (Edm.String) - Author name - **AuthorUUID** (Edm.Guid) - Author unique identifier - **CreatedBy** (Edm.String) - User who created the entry - **CreatedOn** (Edm.Guid) - Creation timestamp - **LanguageCode** (Edm.String) - Language code of the text - **LanguageCodeText** (Edm.String) - Language description - **LastUpdatedBy** (Edm.String) - User who last updated the entry - **ObjectID** (Edm.String) - Unique object identifier - **ParentObjectID** (Edm.String) - Parent object identifier - **Text** (Edm.String) - The content of the note - **TypeCode** (Edm.Guid) - Type code of the text - **TypeCodeText** (Edm.String) - Description of the type code - **UpdatedOn** (Edm.String) - Last update timestamp ``` -------------------------------- ### Visit Collection Source: https://help.sap.com/docs/sap-cloud-for-customer/odata-services/visit The Visit collection allows users to retrieve and manage information regarding customer site visits. It includes various properties for tracking visit details, scheduling, and organizational context. ```APIDOC ## Visit Collection ### Description The Visit collection provides information about customer site visits, including scheduling, location, and organizational details. ### Properties - **AllDayEvent** (Edm.Boolean) - Indicates if the visit is an all-day event. - **AccountUUID** (Edm.Guid) - Unique identifier for the account. - **DistributionChannel** (Edm.String) - Distribution channel code. - **Division** (Edm.String) - Division code. - **EndDateTime** (c4codata.LOCALNORMALISED_DateTime) - The end date and time of the visit. - **ID** (Edm.String) - The visit identifier. - **ObjectID** (Edm.String) - The unique object identifier. - **StartDateTime** (c4codata.LOCALNORMALISED_DateTime) - The start date and time of the visit. - **Status** (Edm.String) - The status code of the visit. - **Subject** (Edm.String) - The subject or title of the visit. ### Navigations - **Visit Attachment** (VisitAttachment) - Navigates to attachments associated with the visit (Cardinality: 1..*) ```