© 2022 SAP SE or an SAP affiliate company. All rights reserved.

PUBLIC
2022-10-31

OData Services

THE BEST RUN

Content

1 SAP Cloud for Customer OData API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.1 What's New in OData API v2 Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.2 Add Public Solution Model (PSM) Fields to Standard OData Services. . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.3 Transport Custom OData Services with Transport Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.4 Compatibility Mode for READ Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.5 Support for User-Friendly IDs in Standard OData Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
2.6 Constant Values to Function Imports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

3 OData API Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

3.1 OData API v2 Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
3.2 OData API v1 Reference (Deprecated). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Account Contact Relationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Account EntityType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Appointment Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
BusinessPartner Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CodeList Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Contextual CodeList Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Contact Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
EMail Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Employee Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
External ID Mapping Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Individual Customer Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Lead Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Sales Lead Entity Type (Deprecated). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Opportunity Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Phone Call Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Product Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Service Request Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Task Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
TimeEntry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
User Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180
Visit Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Marketing Attributes Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
HTTP Status Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Service Assignment Entity Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196

OData Services
2 PUBLIC Content
4 OData Service Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
4.1 Creating an OData Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
4.2 Testing an OData Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208

5 OData API Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

6 (Deprecated) Setting Up OData Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

7 SAP Cloud for Customer OData Developer's Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

8 Additional Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

OData Services
Content PUBLIC 3
1 SAP Cloud for Customer OData API

The SAP Cloud for Customer OData API conforms to OData version 2 specification.

The complete list of collections (or data end-points) of SAP Cloud for Customer OData API, are listed in the OData
API Reference section of this document.

Related Information

OData Version 2.0 Specification

SAP Cloud for Customer OData API 2.0 Reference

1.1 Purpose

Use the OData API, to query, read, add, update and delete data from and into SAP Cloud for Customer.

This document is a reference point for learning SAP Cloud for Customer OData API. You'll find a short introduction
to the capabilities of the OData API as well as information on where to find more details.

1.2 What is OData?

OData (Open Data Protocol) is an OASIS Standard that defines a protocol for building and consuming RESTful APIs,
based on the HTTP protocol.

OData differentiates itself from most of the other RESTful APIs, mainly by providing the following:

• Metadata of the entities exposed by the OData service

• Relationship between the entities within an OData service
• System and custom query options for retrieving data

The protocol allows filtering data, ordering and paginating of the query results, retrieving number of records, and
more. Querying and modifying data is possible in XML (AtomPub) and JSON formats.

For more information on OData protocol, please visit to http://www.odata.org, where you can find different versions
of OData specifications, community resources (such as OData providers and consumer libraries), sample OData
services and tutorials.

OData Services
4 PUBLIC SAP Cloud for Customer OData API
Related Information

https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=odata
http://www.odata.org/

1.3 Accessing OData API

You can access the SAP Cloud for Customer OData API of your tenant, with the URL pattern: https://
<your_tenant>/sap/c4c/odata/v1/c4codataapi

1.4 Accessing Metadata of the OData API

You can access the metadata of the OData API of your tenant, with the URL pattern: https://
<YourTenant>/sap/c4c/odata/v1/c4codataapi/$metadata

1.5 Authentication

Learn about security options for accessing the SAP Cloud for Customer OData API.

Client applications using the OData API, have four options for providing authorization and authentication for their
users:

• Basic Authentication
• OAuth 2.0
• X.509
• SAML (Security Assertion Markup Language) based single sign-on.

Using OAuth 2.0 requires a trust relationship to be configured between SAP Cloud for Customer and the identity
provider of your client application in the Administrator work center.

See Create Trust Between the Customer Account and SAP Cloud for Customer.

OData Services
SAP Cloud for Customer OData API PUBLIC 5
1.6 Authorization

Authorization of a business user in the user interface is usually the same as the authorization in OData Services.
However, there are some exceptions to this behavior.

Exceptions to Authorization Behavior

See the following table to learn about the exceptions.

Behavior in User Interface

Use Case Description (UI) Behavior in OData Service

Restriction at Work Center Work center view is assigned Work center view is visible OData service with work cen­
without data restriction. ter view assigned has full ac­
View with no restrictions in the Ad­
cess to all data and opera­
ministrator work center.
tions.

Access Restriction at In­ Work center view is assigned Work center view is visible, OData honors RBAM restric­
stance with Read and Write restric­ and data visibility is restricted tion and limits the access.
tion. as configured in user access
Example: Only opportunities
management.
Example: Opportunity with with sales territory 17 are
sales territory 17 is restricted Example: User can see oppor­ available. Create/Update/
(both Read and Write) for the tunities with sales territory 17 Delete is restricted for oppor­
user. only. tunities with sales territory 17.

Restrictions in Field You can use business roles to The object work list (OWL) OData doesn’t honor field re­
restrict (Hide/ReadOnly/ doesn’t hide the restricted striction and field is visible in
UnRestricted) the fields (hidden) field, but data isn’t response.
(standard and extension) from displayed.
the work center views added
Thing Inspector UI hides the
to business role.
restricted field.
Example:
ExpectedRevenueAmout
field in an opportunity is hid­
den.

Action Restriction You can use business roles to UI restricts user from execut­ Restriction isn’t honored. It’s
restrict business object ac­ ing the action. possible to execute the re­
tions. stricted function import.

Example: The action Won in

Opportunity is restricted for
the business role.

SAP Key User Tool (KUT) KUT fields with business logic. UI honors KUT adaptations KUT adaptations aren’t hon­
ored.
Adaptations
Example: KUT field’s visibility
based on business role.

OData Services
6 PUBLIC SAP Cloud for Customer OData API
 Behavior in User Interface
Use Case Description (UI) Behavior in OData Service

UI Switches UI switches are defined by UI switches are honored as UI Switches aren’t honored.
custom development and can configured.
Data encapsulated within sec­
be used to make fields, but­
tion groups that is hidden via
tons, or sections of user inter­
UI switch is available in OData
faces hidden, read-only, or
response.
mandatory. You can use them
to assign a particular version
of a UI to a business role and
to its affected users.

Example: A UI section group is

read-only. And another one is
hidden.

To learn more about UI switches, see the blog Make a UI flexible/dynamic using UI Switch .

Enhancements to Authorization Assignment

Authorization assignments for several OData services are enhanced. With this enhancement, users require the
necessary authorizations to consume these OData services.

In previous releases, your users may have been able to consume the impacted OData services without the
necessary authorization assignments. For those users, this is an incompatible change. As of the August 2020
release, you must assign the work center view assignments as listed in the table for these users.

Here is a list of impacted services:

Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

prcconver­ CodPrcCon­ Prc Conver­ COD_QUOT Yes

sionfactors versionFac­ sion Factors
E_WCVIEW
tors
COD_SALE
SORDER_W
CVIEW

prccurren­ CodPrcCur­ Prc Cur­ COD_QUOT Yes

cycode­ rencyCode­ rency Code
E_WCVIEW
names Names Names
COD_SALE
SORDER_W
CVIEW

OData Services
SAP Cloud for Customer OData API PUBLIC 7
 Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

prccurren­ CodPrcCur­ Prc Cur­ COD_QUOT Yes

cycodes rencyCodes rency Codes
E_WCVIEW

COD_SALE
SORDER_W
CVIEW

prccurren­ CodPrcCurr­ Prc Cur­ COD_QUOT Yes

cydecplaces DecPlaces rency Deci­
E_WCVIEW
mal Places
COD_SALE
SORDER_W
CVIEW

prccurrewu­ CodPrcEwu­ Prc Ewukeys COD_QUOT Yes

keys keys
E_WCVIEW

COD_SALE
SORDER_W
CVIEW

prcexchang­ CodPrcEx­ Prc Ex­ COD_QUOT Yes

erates changeR­ change
E_WCVIEW
ates Rates
COD_SALE
SORDER_W
CVIEW

prcexchan­ CodPrcEx­ Prc Ex­ COD_QUOT Yes

geratetypes changeRa­ change Rate
E_WCVIEW
teTypes Types
COD_SALE
SORDER_W
CVIEW

prcexpiring­ CodPrcExp­ Prc Expiring COD_QUOT Yes

currencies Curr Currency
E_WCVIEW

COD_SALE
SORDER_W
CVIEW

OData Services
8 PUBLIC SAP Cloud for Customer OData API
 Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

prcobjty­ CodPrcObj­ Prc Obj Type COD_QUOT Yes

peexpcurr TypExpCurr for Exp Cur­
E_WCVIEW
rency
COD_SALE
SORDER_W
CVIEW

prcquota­ CodPrcQuo­ Prc Quota­ COD_QUOT Yes

tionprefix tationPrefix tion Prefix
E_WCVIEW

COD_SALE
SORDER_W
CVIEW

prcquota­ CodPrcQuo­ Prc Quota­ COD_QUOT Yes

tions tations tions
E_WCVIEW

COD_SALE
SORDER_W
CVIEW

prcwarnper­ CodPrcWar­ Prc Warning COD_QUOT Yes

expcurr PerExpCurr Period for
E_WCVIEW
Exp Cur­
rency COD_SALE
SORDER_W
CVIEW

socialme­ SocialMe­ Social Me­ SEOD_SMA Yes

diaactivity diaActivity dia Activity _SADL_WC
VIEW

socialme­ SocialMe­ Social Me­ SEOD_SMA Yes

diaactivity diaActivi­ dia Activity _SADL_WC
tyAccess­ Access Con­ VIEW
ControlList trol List

socialme­ SocialMe­ Social Me­ SEOD_SMA Yes

diaactivity diaActivi­ dia Activity _SADL_WC
tyAttach­ Attach­ VIEW
mentFolder ments

socialme­ SocialMe­ Social Me­ SEOD_SMA Yes

diaactivity diaActivity­ dia Activity _SADL_WC
ToChildSo­ Child Social VIEW
cialMe­ Media Activ­
diaActivity ities

OData Services
SAP Cloud for Customer OData API PUBLIC 9
 Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

socialme­ SocialMe­ Social Me­ COD_CONT No

diauserpro­ dia User
diaUserPro­ ACT_WCV
filewithou­ Profile No
fileNoAuth
tauth Auth COD_SEOD
_ACCOUNT
WL_WCVIE
W

socialme­ SocialMe­ COD_CONT No

diauserpro­
diaUserPro­ ACT_WCV
filewithou­
fileNoAuth­
tauth COD_SEOD
ToSocialMe­
diaBupaRe­ _ACCOUNT
ference WL_WCVIE
W

socialme­ SocialMe­ Social Me­ COD_CONT No

diauserpro­ dia User
diaUserPro­ ACT_WCV
filewithou­ Profile User
fileNoAuth­
tauth Information COD_SEOD
ToSocialMe­
diaUserIn­ _ACCOUNT
formation WL_WCVIE
W

survey AnswerAt­ Answer At­ COD_QUES No

tachment tachments
TIONNAIR
E_WCVIEW

survey AnswerAt­ Answer At­ COD_QUES No

tachmen­ tachment
TIONNAIR
E_WCVIEW
tReference Reference

survey AnswerOp­ Answer Op­ COD_QUES No

tions tions
TIONNAIR
E_WCVIEW

survey Answers Answers COD_QUES No

TIONNAIR
E_WCVIEW

survey Branching­ Branching COD_QUES No

Conditions Conditions
TIONNAIR
E_WCVIEW

OData Services
10 PUBLIC SAP Cloud for Customer OData API
 Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

survey ElementRat­ Element COD_QUES No

ing Rating
TIONNAIR
E_WCVIEW

survey Elemen­ Element Re­ COD_QUES No

tRespon­ sponse Op­

TIONNAIR
E_WCVIEW
seOption tion

survey Questio­ Question COD_QUES No

nAnswers Answers
TIONNAIR
E_WCVIEW

survey QuestionAt­ Question At­ COD_QUES No

tachment tachments
TIONNAIR
E_WCVIEW

survey Questions Questions COD_QUES No

TIONNAIR
E_WCVIEW

survey Response Response COD_QUES No

TIONNAIR
E_WCVIEW

survey ResponseI­ Response COD_QUES No

tem Item
TIONNAIR
E_WCVIEW

survey ResponseI­ Response COD_QUES No

temAttach­ Item Attach­

TIONNAIR
E_WCVIEW
ment ments

survey Survey Question­ COD_QUES No

naire
TIONNAIR
E_WCVIEW

survey SurveyDe­ Question­ COD_QUES No

signTime naire
TIONNAIR
E_WCVIEW

timereport CodTimeEn­ Time Entry COD_SEOD Yes

try _TR_TIME
REPORT_W
CV

timereport CodTimeRe­ Time Report COD_SEOD Yes

port _TR_TIME
REPORT_W
CV

OData Services
SAP Cloud for Customer OData API PUBLIC 11
 Authoriza­
tion Assign­
ment Data Work­
OData Entity Type
bench Rele­
Service Entity Type UI Text (La­ (Assign at vant Serv­
Name Name bel) least one.) ice

timereport CodTimeRe­ Time Report COD_SEOD Yes

portAttach­ Attach­ _TR_TIME
mentFolder ments REPORT_W
CV

timereport CodTimeRe­ Cod Time COD_SEOD Yes

portParty Report Party _TR_TIME
REPORT_W
CV

 Caution

As an administrator, you can assign any workcenter to a OData service without validating the assignment. This
will result in business partners with the same workcenter assigned having access to the OData service and
being able to retrieve data that are not visible to them in the UI. Hence, you must be cautious while assigning
workcenters.

1.7 Supported System Query Options

SAP Cloud for Customer OData API supports OData V2 system query options listed below:

• $count
• $expand
• $filter
• $format
• $inlinecount
• $orderby
• $search
• $select
• $skip
• $skiptoken
• $top

Usage information, examples and possible restrictions are described in the SAP Cloud for Customer OData
Developer’s Guide .

OData Services
12 PUBLIC SAP Cloud for Customer OData API
2 New Features

2.1 What's New in OData API v2 Reference

2.1.1 Business Partner OData Services

This topic lists all OData API documentation that have been modified in each release version.

August 2021 Edition

OData API documentation enhanced in the following KT (knowledge transfer documents):

• ODATA_BUPA_RELATIONSHIP_1
• ODATA_COMPETITOR_01
• ODATA_CONTACT_01
• ODATA_CUSTOMER_01
• ODATA_EMPLOYEEANDUSER_01
• ODATA_IND_CUSTOMER_01
• ODATA_PARTNERCONTACT_01
• ODATA_PARTNER_01
• ODATA_SERVICEAGENT_01

May 2021 Edition

OData API documentation enhanced in the following KT (knowledge transfer documents):

• ODATA_CONTACT_01
• ODATA_CUSTOMER_01
• ODATA_IND_CUSTOMER_01

February 2021 Edition

OData API documentation enhanced in the following KT (knowledge transfer documents):

OData Services
New Features PUBLIC 13
• ODATA_ACCOUNT_DC_01
• ODATA_CONTACT_04
• ODATA_CUSTOMER_02
• ODATA_CUSTOMER_07
• ODATA_IND_CUSTOMER_02
• ODATA_IND_CUSTOMER_06

November 2020 Edition

OData API documentation enhanced in the following KT (knowledge transfer documents):

• ODATA_BUPA_RELATIONSHIP_1
• ODATA_BUPA_RELATIONSHIP_2
• ODATA_BUSINESSPARTNER_01
• ODATA_BUSINESSUSER_01
• ODATA_COMPETITOR_01
• ODATA_CONTACT_01
• ODATA_CONTACT_02
• ODATA_CONTACT_06
• ODATA_CUSTOMER_01
• ODATA_CUSTOMER_02
• ODATA_CUSTOMER_05
• ODATA_CUSTOMER_14
• ODATA_EMPLOYEEANDUSER_01
• ODATA_IND_CUSTOMER_01
• ODATA_IND_CUSTOMER_02
• ODATA_IND_CUSTOMER_05
• ODATA_MARKETINGATTRIBUTE_10
• ODATA_PARTNERCONTACT_01
• ODATA_PARTNER_01
• ODATA_PARTNER_02
• ODATA_SERVICEAGENT_01

May 2020 Edition

OData API documentation enhanced in the following KT (knowledge transfer documents):

• ODATA_ACCOUNTHIERARCHYLIST_01
• ODATA_BUYINGCENTER_1
• ODATA_BUYINGCENTER_2
• ODATA_CONTACT_01

OData Services
14 PUBLIC New Features
• ODATA_CUSTOMER_04
• ODATA_EMPLOYEEANDUSER_01
• ODATA_EMPLOYEE_BASIC_DATA_01
• ODATA_IND_CUSTOMER_04
• ODATA_MARKETINGATTRIBUTE_1
• ODATA_MARKETINGATTRIBUTE_10
• ODATA_MARKETINGATTRIBUTE_2
• ODATA_MARKETINGATTRIBUTE_3
• ODATA_MARKETINGATTRIBUTE_4
• ODATA_MARKETINGATTRIBUTE_5
• ODATA_MARKETINGATTRIBUTE_6
• ODATA_MARKETINGATTRIBUTE_7
• ODATA_MARKETINGATTRIBUTE_8
• ODATA_MARKETINGATTRIBUTE_9

February 2020 Edition

OData API documentation enhanced in the following KT (knowledge transfer) documents:

• ODATA_EMPLOYEEANDUSER_01
• ODATA_EMPLOYEEANDUSER_02
• ODATA_EMPLOYEEANDUSER_03
• ODATA_EMPLOYEEANDUSER_04
• ODATA_EMPLOYEEANDUSER_05
• ODATA_IDENTITY_01
• ODATA_IND_CUSTOMER_DC_01
• ODATA_ACCOUNT_DC_01
• ODATA_CUSTOMER_01
• ODATA_CUSTOMER_02
• ODATA_CUSTOMER_04
• ODATA_CUSTOMER_06
• ODATA_BUPAMERGE_01
• ODATA_IND_CUSTOMER_01
• ODATA_IND_CUSTOMER_02
• ODATA_IND_CUSTOMER_04
• ODATA_CONTACT_01
• ODATA_BUSINESSUSER_01
• ODATA_BUPA_RELATIONSHIP_1
• ODATA_MARKETINGATTRIBUTE_1
• ODATA_MARKETINGATTRIBUTE_2
• ODATA_MARKETINGATTRIBUTE_3
• ODATA_MARKETINGATTRIBUTE_4

OData Services
New Features PUBLIC 15
• ODATA_MARKETINGATTRIBUTE_5
• ODATA_MARKETINGATTRIBUTE_6
• ODATA_MARKETINGATTRIBUTE_7
• ODATA_MARKETINGATTRIBUTE_8
• ODATA_MARKETINGATTRIBUTE_9
• ODATA_MARKETINGATTRIBUTE_10

2.2 Add Public Solution Model (PSM) Fields to Standard

OData Services

As an administrator, you can add PSM fields to standard OData services.

1. Click your profile on the top right corner of your screen, and select Start Adaptation.
2. Navigate to the screen where the PSM field exists and click to select the relevant section. The system
highlights the section with a red box.
3. In the side pane, click next to Header to see the list of available fields.
4. Navigate to the PSM field and click next to it. The system highlights the PSM field with a red box to indicate
that it is editable.
5. Click Edit. The system displays the table with the list of available OData extensions.
6. Click the Edit icon and the Action column appears in the table.
7. Under Action, click the Add Field icon next to the OData Service where you want to add the PSM field. The
system indicates that it has been added with a check sign in the Field Added column.
8. Click Save.

 Note

• This is applicable only for standard PSM fields extended via adaptation. PSM fields created using SAP
Cloud Applications Studio are not supported.
• You can transport PSM OData configuration from a test to a productive environment via Transport
Management. In Transport Management, the Adaptation Changes provider proposes relevant PSM OData
configuration as optional dependencies.
• You cannot remove a PSM field from an OData service if it is already shipped as part of standard OData
service by SAP.
• This feature is not available for the Lead UIs, such as Lead, Lean Lead, and Deal Registration UIs.

2.3 Transport Custom OData Services with Transport

Management

You can use Transport Management to move custom OData Services between different tenants.

Follow this procedure to add a custom OData Service in a Transport Request:

OData Services
16 PUBLIC New Features
1. To add a Transport Object, under Transport Object Type, select Custom OData Service.
2. Select the Custom Service Name and then click OK.
3. Select the transport object and click Add Selected.

Related Information: See Configure a Transport Request.

2.4 Compatibility Mode for READ Operations

We’ve introduced a new HTTP request header odata-v2-strict-json-format : true, which changes the
results tag in response as follows:

• READ operations with key have results tag.

• Expand operations with NavigationProperty with 'many' cardinality have the results tag.

When you use this header, you receive a response payload that is compatible with OData API v2 protocol.

This feature is helpful if you use third-party tools that require strict adherence to the OData V2 protocol.

2.5 Support for User-Friendly IDs in Standard OData Services

User-friendly IDs (UIDs or Known IDs) are available as a key to read, update, and delete data records via standard
OData services.

UIDs are the same as the IDs displayed in the user interface and therefore, are more user-friendly. This feature is
offered as an alternative to ObjectID as the key.

ObjectID is used as the key if a UID isn't configured for an entity type. To find the entity type that support UIDs, see
the OData metadata.

https://myxxxxxx.crm.ondemand.com/sap/c4c/odata/uid/v1/c4codataapi/$metadata.

2.6 Constant Values to Function Imports

Assign constant values to function imports of type Query.

This feature allows constant values to be passed to a query that simplifies the associated Query request by
reducing the number of parameters required.

For example, in a custom OData service, Activity (BO): Query: QueryByElements.

If only appointments have to be retrieved using this query (and not other activity types such as email and fax),
query parameters TypeCode, GroupCode can be assigned with the following constant values: TypeCode
EQ ”12” and GroupCode NE “0027”.

OData Services
New Features PUBLIC 17
3 OData API Reference

3.1 OData API v2 Reference

OData API v2 covers over 40 main business objects, allowing read and/or write access to more than 1000
collections (data points). You can access the API reference document here: OData API v2 Reference.

You can access the metadata of the OData API of your tenant, with the URL pattern: https://
<YourTenant>/sap/c4c/odata/v1/c4codataapi/$metadata

Add Extension Fields to c4codataapi

The service c4codataapi is a container for several individual object-specific OData services. Hence, extension
fields must be added to these individual services. Extension fields added to individual services automatically reflect
in c4codataapi. The individual services that you need to select when adding an extension field to a particular object
is listed here.

 Note

The c4codataapi service does not appear in Key User Extension UI and SAP Cloud Applications Studio.

Object/Entity Type Service

Appointment activity

EMail activity

Phone Call activity

Task activity

Visit activity

Business Partner Relationship businesspartnerrelationship

Buying Center buyingcenter

Campaign campaign

Chat Activity chatactivity

Competitor competitor

Competitor Product competitorproduct

OData Services
18 PUBLIC OData API Reference
Object/Entity Type Service

Contact contact

Contract contract

Account customer

Individual Customer customer

Employee employeeanduser

Installation Point ( Product / Text / Functional Location ) installationpoint

Installed Base installedbase

Job Definition jobdefinition

Lead lead

Marketing Permission marketingpermission

Measurement Point measurementpoint

Measurment Document measurementreading

Opportunity opportunity

Organisational Unit organisationalunit

Partner partner

Partner Contact partnercontact

Deal Questionnaire pcmmigration

Deal Registration pcmmigration

Product product

Product List productbusinesspartnerrelation

Registered Product registeredproduct

Sales Point Of Delivery salespointofdelivery

Sales Quote salesquote

Sales Territory salesterritory

Service Agent serviceagent

Activity Extension serviceassignment

OData Services
OData API Reference PUBLIC 19
Object/Entity Type Service

Social Media Activity socialmediaactivity

Social Media User Profile socialmediauserprofile

Stock Location stocklocation

Questionnaire survey

Target Group Root targetgroup

Service Request ticket

Time Entry timeentry

Time Report timereport

3.2 OData API v1 Reference (Deprecated)

SAP Cloud for Customer OData API v1 is deprecated.

Information on Deprecation

See information on deprecation and our updated API Strategy [page 201].

OData API v1 Reference (Deprecated)

This section shows the OData entity structure is shown as diagrams.

The entity diagrams are grouped under following sections:

• Account EntityType [page 22]

• Contact Entity Type [page 50]
• Sales Lead Entity Type (Deprecated) [page 108]
• Opportunity Entity Type [page 118]
• Employee Entity Type [page 69]
• Product Entity Type [page 143]
• Service Request Entity Type [page 151]
• Visit Entity Type [page 183]

Group Name Activities:

OData Services
20 PUBLIC OData API Reference
• Appointment Entity Type [page 40]
• EMail Entity Type [page 61]
• Phone Call Entity Type [page 137]
• Task Entity Type [page 170]

 Note

For details on the associations between entities, see the navigation details of the respective entity.

The accuracy of the information provided about the Nullable property in the SAP Cloud for Customer OData
API collection document might not always be accurate. If the Nullable attribute has the value:

• True, then this property can be left empty. In some cases, due to application-specific behavior, or the
dependency on the value of another property, a property value must be specified even if the value of the
Nullable property is indicated as True. For create or update calls on such properties, the system returns a
specific error message if the value is left blank.
• False, such a property must never be left blank.

3.2.1 Account Contact Relationship

Overview

AccountContactRelationship entity type is already part of C4CODATA, as a part of clean up duplicate entries from
other entity type of AccountContactRelationship which is AccountContactCommunicationData.

Properties

Name Type Description $search relevant

EMail Edm.String E-Mail

Fax Edm.String Fax

JobTitle Edm.String Job Title

Mobile Edm.String Mobile

Phone Edm.String Phone

OData Services
OData API Reference PUBLIC 21
3.2.2 Account EntityType

The Account related collections allow you to read and maintain Accounts and their related data such as Address,
Contacts related to the Accounts and their addresses.

3.2.2.1 Account

Overview

The Account collection provides information about corporate customers and prospects. These are existing
organizations and potential customers for the company.

OData Services
22 PUBLIC OData API Reference
URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/AccountCollection

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ABCClassification- Edm.String true 1 true

Code

ABCClassification- Edm.String true

CodeText

AccountFormatted­ Edm.String false 40 true true

Name

AccountID Edm.String true 10 true true

AccountName Edm.String true 240 true true

AccountName2 Edm.String true 240 true

AccountName3 Edm.String true 240 true

AccountName4 Edm.String true 240 true

AdditionalStreet­ Edm.String true 240 true

PrefixName

AdditionalStreet­ Edm.String true 240 true

SuffixName

StreetPrefixName Edm.String true 240 true

StreetSuffixName Edm.String true 240 true

BuildingID Edm.String true 240 true

CareOfName Edm.String true 240 true

CatagoryCode Edm.String false 1 true true

CatagoryCodeText Edm.String true

ChangedBy Edm.String true 40 true

ChangedOn Edm.DateTime true

OData Services
OData API Reference PUBLIC 23
Name Type Nullable Max Length Fixed length $ Search Relevant

CityName Edm.String true 240 true

ContactPermis­ Edm.String true 1 true

sionCode

ContactPermis­ Edm.String true

sionCodeText

Correspondence­ Edm.String true 1 true

LanguageCode

Correspondence­ Edm.String true true

LanguageCodeText

CountryCode Edm.String true 3 true

CountryCodeText Edm.String true

CountyName Edm.String true 240 true

CreatedBy Edm.String true 40 true

CreatedOn Edm.DateTime true

DUNS Edm.String true 60 true

DistrictName Edm.String true 240 true

EMail Edm.String true 765 true

Fax Edm.String true 350 true

HouseID Edm.String true 100 true

IndustryCode Edm.String true 10 true

IndustryCodeText Edm.String true

LegalFormCode Edm.String true 2 true

LegalFormCode­ Edm.String true

Text

MarketingLeadIndi­ Edm.Boolean true

cator

Mobile Edm.String true 350 true

NielsenID Edm.String true 2 true

NielsenIDText Edm.String true

OData Services
24 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String false 70 true

OwnerFormatted­ Edm.String true 480 true

Name

OwnerID Edm.String true 20 true

OwnerUUID Edm.Guid true

POBoxDeviatingCi­ Edm.String true 240 true

tyName

POBoxDeviating­ Edm.String true true

CountryCode

POBoxDeviating­ Edm.String true 3 true

CountryCodeText

POBoxDeviatingRe­ Edm.String true true

gionCode

POBoxDeviatingRe­ Edm.String true 6 true

gionCodeText

POBoxID Edm.String true 100 true

POBoxPostalCode Edm.String true true

POBoxPostalCode­ Edm.String true true

Text

Phone Edm.String true 350 true

PreferredCommu­ Edm.String true 3 true

nicationMediumTy­
peCode

PreferredCommu­ Edm.String true

nicaTexttionMe­
diumTypeCode

PrimaryContactID Edm.String true 10 true

PrimaryContact­ Edm.String false 480 true true

Name

RoleCode Edm.String true 6 true

RoleCodeText Edm.String true

StatusCode Edm.String true 2 true

OData Services
OData API Reference PUBLIC 25
Name Type Nullable Max Length Fixed length $ Search Relevant

StatusCodeText Edm.String true

StreetName Edm.String true 360 true

StreetPostalCode Edm.String true 100 true

StreetPostalCode­ Edm.String true true

Text

Tax.Jurisdiction­ Edm.String true 25 true

Code

TaxJurisdictionCo­ Edm.String true true

deText

TimeZoneCode Edm.String true 10 true

TimeZoneCodeText Edm.String true true

UUID Edm.Guid true

Web Edm.String true 1280 true

Navigations

Name FromEntity ToEntity

AccountAddress Account AccountAddress 1 .. *

AccountAttachment Account AccountAttachment 1 .. *

AccountContactRelationship Account AccountContactRelationship 1 .. 1

AccountNotes Account AccountNotes 1 .. *

AccountRole Account AccountRole 1 .. *

AccountSalesData Account AccountSalesData 1 .. *

AccountTeam Account AccountTeam 1 .. *

ExternalIDMapping Account ExternalIDMapping 1 .. *

OData Services
26 PUBLIC OData API Reference
3.2.2.2 AccountAddress

Overview

The AccountAddress collection provides detailed organization address of corporate customer and prospects.

Top Level Entity

Account

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

AdditionalStreet­ Edm.String true 240 true

PrefixName

AdditionalStreet­ Edm.String true 240 true

SufixName

StreetPrefixName Edm.String true 240 true

lStreetSufixName Edm.String true 240 true

CareOfName Edm.String true 240 true

AddressLine1 Edm.String true 240 true

AddressLine2 Edm.String true 240 true

AddressLine4 Edm.String true 240 true

AddressLine5 Edm.String true 240 true

CareOfName Edm.String true 240 true

City Edm.String true 240 true

CountryCode Edm.String true 3 true

CountryCodeText Edm.String true

EMail Edm.String true 765 true

Fax Edm.String true 350 true

FormattedAddress Edm.String true 480 true

Latitude Edm.Decimal true

Longitude Edm.Decimal true

OData Services
OData API Reference PUBLIC 27
Name Type Nullable Max Length Fixed length $ Search Relevant

Mobile Edm.String true 350 true

ObjectID Edm.String true 70 true

POBox Edm.String true 100 true

POBoxAddress Edm.Boolean true

POBoxPostalCode Edm.String true 100 true

POBoxPostalCode­ Edm.String true

Text

ParentObjectID Edm.String true 70 true

Phone Edm.String true 350 true

PostalCode Edm.String true 100 true

PostalCodeText Edm.String true

State Edm.String true 6 true

StateText Edm.String true

Street Edm.String true 360 true

UUID Edm.Guid true

Navigations

Name FromEntity ToEntity

Account AccountAddress Account * ..1

3.2.2.3 Account Attachment

Overview

The AccountAttachment collection provides information about various attachments such as Documents, Images
etc. associated to a particular Corporate Customer.

These attachment types can be created, updated, and viewed using this collection.

OData Services
28 PUBLIC OData API Reference
Top Level Entity

Account

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Binary Edm.Binary true false

CategoryCode Edm.String false 1 true

CategoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LastUpdatedBy Edm.String true 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURI Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

3.2.2.4 Account Contact Communication Data

Overview

The AccountContactCommunicationData collection provides information about personal workplace address

details of the Contact related to an Account.

OData Services
OData API Reference PUBLIC 29
Top Level Entity

Account

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

EMail Edm.String true 765 true

Fax Edm.String true 350 true

JobTitle Edm.String true 240 true

Mobile Edm.String true 350 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Phone Edm.String true 350 true

Navigations

Name From Entity To Entity Cardinality

AccountContactRelationship AccountContactCommunica­ AccountContactRelationship 1 ..1

tionData

3.2.2.5 Account Contact Relationship

Overview

The AccountContactRelationship collection sets up the relationship between contact and accounts. A single
contact can be associated with multiple Accounts and vice versa.

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

CategoryCode Edm.String true 16 true

OData Services
30 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $ Search Relevant

AccountUUID Edm.String true

CategoryCodeText Edm.String true

ContactUUID Edm.Guid true

DepartmentCode Edm.String true 4 true

DepartmentCode­ Edm.String true

Text

FunctionCode Edm.String true 4 true

FunctionCodeText Edm.String true

Main Edm.Boolean true

ObjectID Edm.String true 70 true

VIPReasonCode Edm.String true 1 true

VIPReasonCode­ Edm.String true

Text

Navigations

Name From Entity To Entity Cardinality

AccountContactCommunica­ AccountContactRelationship AccountContactCommunica­ 1 ..1

tionData tionData

AccountContacts AccountContactRelationship AccountContacts

3.2.2.6 Account Contacts

Overview

The AccountContacts collection provides information about contacts related to an account.

Usage Scenario

The AccountContacts cannot be created whereas can be updated. This displays the contact details provided in the
AccountContactRelationship.

OData Services
OData API Reference PUBLIC 31
Top Level Entity

AccountContactRelationship

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

CategoryCode Edm.String true 1 true

CategoryCodeText Edm.String true

ContactID Edm.String true 10 true

ContactUUID Edm.Guid true

EndDate Edm.DateTime true

FirstName Edm.String true 240 true

LastName Edm.String true 240 true

Name Edm.String true 480 true

ObjectID Edm.String true 70 true

RoleCode Edm.String true 6 true

RoleCodeText Edm.String true

StartDate Edm.DateTime true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

3.2.2.7 AccountNotes

Overview

The AccountNotes collection provides information about the corporate customers and prospects, and allows to
add and view the data.

Top Level Entity

Account

OData Services
32 PUBLIC OData API Reference
Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Text Edm.String true false

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UpdatedOn Edm.DateTime true

Navigations

Name From Entity To Entity Cardinality

AccountContactCommunica­ AccountContactRelationship AccountContactCommunica­ 1 ..1

tionData tionData

AccountContacts AccountContactRelationship AccountContacts

3.2.2.8 Account Role

Overview

The AccountRole collection provides information about the role(s) of an Account.

Top Level Entity

Account

OData Services
OData API Reference PUBLIC 33
Usage

The property RoleCode has an associated collection – AccountRoleCodeCollection that gives the list of all the roles
and its descriptions. This collection can be used to find the values that can be given for the property RoleCode
during the creation of this entity.

Properties

Name Type Nullable Max Length Fixed length

BusinessCharacter­ Edm.String TRUE 6 TRUE

Code

BusinessCharacterCo­ Edm.String TRUE

deText

ObjectID Edm.String TRUE 70 TRUE

ParentObjectID Edm.String TRUE 70 TRUE

RoleCode Edm.String TRUE 6 TRUE

RoleCodeText Edm.String TRUE

Navigations

Name FromEntity ToEntity

Account Account AccountRole 1..n

3.2.2.9 AccountSalesData

Overview

The AccountSalesDataCollection provides information about sales related data for an account like sales
organization, group and its associated incoterms, and payment terms.

OData Services
34 PUBLIC OData API Reference
Top Level Entity

Account

Properties

Name Type Nullable Max Length Fixed length

BillingBlockingReason­ Edm.String TRUE 2 TRUE

Code

BillingBlockingReason­ Edm.String TRUE

CodeText

CurrencyCode Edm.String TRUE 3 TRUE

CurrencyCodeText Edm.String TRUE

CustomerGroupCode Edm.String TRUE 2 TRUE

CustomerGroupCode­ Edm.String TRUE

Text

DeliveryBlockingRea­ Edm.String TRUE 2 TRUE

sonCode

DeliveryBlockingRea­ Edm.String TRUE

sonCodeText

DeliveryPriorityCode Edm.String TRUE 1 TRUE

DeliveryPriorityCode­ Edm.String TRUE

Text

DistributionChannel­ Edm.String TRUE 2 TRUE

Code

DistributionChannelCo­ Edm.String TRUE

deText

DivisionCode Edm.String TRUE 2 TRUE

DivisionCodeText Edm.String TRUE

IncotermsCode Edm.String TRUE 3 TRUE

IncotermsCodeText Edm.String TRUE

IncotermsLocation Edm.String TRUE 28 TRUE

ObjectID Edm.String TRUE 70 TRUE

OrderBlockingReason­ Edm.String TRUE 2 TRUE

Code

OrderBlockingReason­ Edm.String TRUE

CodeText

OData Services
OData API Reference PUBLIC 35
PaymentTermsCode Edm.String TRUE 4 TRUE

PaymentTermsCode­ Edm.String TRUE

Text

SalesGroupID Edm.String TRUE 20 TRUE

SalesGroupUUID Edm.Guid TRUE

SalesOfficeUUID Edm.Guid TRUE

SalesSupportBlockin­ Edm.Boolean TRUE

gIndicator

SalesOrganisationID Edm.String TRUE 20 TRUE

SalesOrganisationUUID Edm.Guid TRUE

Navigations

Name From Entity To Entity Cardinality

AccountSalesGroupName AccountSalesData AccountSalesGroupName 1..n

AccountSalesofficeName AccountSalesData AccountSalesOfficeName 1..n

AccountSalesOrganisation­ AccountSalesData AccountSalesOrganisation­ 1..n

Name Name

3.2.2.10 AccountSalesGroupName

Overview

The AccountSalesGroupName collection provides the list of Sales group names present in the AccountSalesData
entity type.

Top Level Entity

Account; Parent entity is AccountSalesData

OData Services
36 PUBLIC OData API Reference
Properties

Name Type Nullable Max Length Fixed length

Name Edm.String TRUE 40 TRUE

ObjectID Edm.String TRUE 70 TRUE

3.2.2.11 AccountSalesOfficeName

Overview

The AccountSalesOfficeName collection provides the list of all Sales group names present in the AccountSalesData
entity type.

Top Level Entity

Account; Parent entity is AccountSalesData

Properties

Name Type Nullable Max Length Fixed length

Name Edm.String TRUE 40 TRUE

ObjectID Edm.String TRUE 70 TRUE

3.2.2.12 AccountSalesOrganisationName

Overview

The AccountSalesOrganisationName collection provides the list of all Sales group names present in the
AccountSalesData entity type.

OData Services
OData API Reference PUBLIC 37
Top Level Entity

Account; Parent entity is AccountSalesData

Properties

Name Type Nullable Max Length Fixed length

Name Edm.String TRUE 40 TRUE

ObjectID Edm.String TRUE 70 TRUE

3.2.2.13 AccountTeam

Overview

The AccountTeam collection provides information about the team that belongs to a corporate account.

Top Level Entity

Account

Properties

Name Type Nullable Max Length Fixed length

DistributionChannel­ Edm.String TRUE 2 TRUE

Code

DistributionChannelCo­ Edm.String TRUE

deText

DivisionCode Edm.String TRUE 2 TRUE

DivisionCodeText Edm.String TRUE

EmployeeUUID Edm.Guid TRUE

OData Services
38 PUBLIC OData API Reference
EndDate Edm.DateTime TRUE

Name Edm.String TRUE 480 TRUE

ObjectID Edm.String TRUE 70 TRUE

ParentObjectID Edm.String TRUE 70 TRUE

PartyRoleCode Edm.String TRUE 10 TRUE

PartyRoleCodeText Edm.String TRUE

SalesOrganisationUUID Edm.Guid TRUE

StartDate Edm.DateTime TRUE

UUID Edm.Guid TRUE

Navigations

Name FromEntity ToEntity

Account AccountTeam Account 1 .. 1

AccountTeamAddress AccountTeam AccountTeamAddress 1 .. 1

3.2.2.14 AccountTeamAddress

Overview

The AccountTeamAddress collection provides the E-mail ID and phone of the employee that belongs to an account
team.

Top Level Entity

Account

OData Services
OData API Reference PUBLIC 39
Properties

Name Type Nullable Max Length Fixed length

EMail Edm.String TRUE 765 TRUE

ObjectID Edm.String TRUE 70 TRUE

Phone Edm.String TRUE 350 TRUE

3.2.3 Appointment Entity Type

The Appointment related collections allow you to read and maintain appointments and related data such as
attachments and involved parties (such as sender, recipient, account etc.)

3.2.3.1 Appointment

Overview

The Appointment collection provides information about appointments.

OData Services
40 PUBLIC OData API Reference
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/AppointmentCollection

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Account c4codata.EN­ true

CRYPTED_LONG_N
ame

AccountID Edm.String true 60 true

AccountUUID Edm.Guid true

AllDayEvent Edm.Boolean true

CategoryCode Edm.String true 4 true

CategoryCodeText Edm.String true

ChangedBy Edm.String true 480 true

ChangedOn Edm.DateTimeOff- true

set

CompletionPercent Edm.Decimal true

CreatedBy Edm.String true 480 true

CreatedOn Edm.DateTimeOff- true

set

EndDateTime c4codata.LOCAL­ true

NORMALISED_Da­
teTime

ID Edm.String false 35 true true

MyPriority Edm.String True 30 True

MyPriorityText Edm.String True 30

ObjectID Edm.String false 70 true

OrganizerID Edm.String true 60 true

OrganizerName c4codata.EN­ true

CRYPTED_LONG_N
ame

OrganizerUUID Edm.Guid true

Owner c4codata.EN­ true

CRYPTED_LONG_N
ame

OData Services
OData API Reference PUBLIC 41
OwnerUUID Edm.Guid true

Phone Edm.String true 350 true

PrimaryContact c4codata.EN­ true

CRYPTED_LONG_N
ame

PrimaryContactID Edm.String true 60 true

PrimaryContac­ Edm.Guid true

tUUID

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.String true

StartDateTime Edm.DateTimeOff- true

set

StatusCode Edm.String true 2 true true

StatusCodeText Edm.String true

Subject Edm.String true 765 true true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

AdditionalLocation­ Edm String true 765 true

Name

GroupwareItemID Edm String true 765 true

LocationName Edm String true 480 true

ReportedDateTime Edm.DateTimeOff- true

set

UUID Edm.Guid false

The Property Type Code has a default value and cannot be changed.

Navigations

Name From Entity To Entity Cardinality

AppointmentAttachment Appointment AppointmentAttachment 1 .. *

AppointmentInvolvedParties Appointment AppointmentInvolvedParties 1 .. *

AppointmentNotes Appointment AppointmentNotes 1 .. *

OData Services
42 PUBLIC OData API Reference
3.2.3.2 Appointment Attachment

Overview

The AppointmentAttachment collection provides information about attachments in Appointments.

Top Level Entity

Appointment

Properties

Name Type Nullable Max Length Fixed length

AuthorName Edm.String True 40 True

AuthorUUID Edm.Guid True

CreatedBy Edm.String True 80 True

CreatedOn Edm.DateTime True

DocumentLink Edm.String True

LastUpdatedBy Edm.String True 80 True

LastUpdatedOn Edm.String True

LinkWebURL Edm.String True 80 False

MimeType Edm.String True False

ObjectID Edm.String True 70 True

ParentObjectID Edm.String True 70 True

TypeCode Edm.String True 5 True

TypeCodeText Edm.String True

UUID Edm.GUID False

OData Services
OData API Reference PUBLIC 43
3.2.3.3 Appointment Involved Parties

Overview

The Appointment Involved Parties collection provides contact information of all parties involved (such as Sender,
Recipient, Account, Employee Responsible etc.) in the appointment..

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Name c4codata.EN­ true

CRYPTED_LONG_N
ame

ObjectID Edm.String false 70 true

ParentObjectIDe Edm.String true 60 true true

Address Edm.String true 480 true true

Email Edm.String true 765 true true

PartyID Edm.String true 60 true

PartyTypeCode Edm.String true 15 true

PartyUUID Edm.String true

Phone Edm.String true 350 true

RoleCode Edm.String true 10 true

RoleCodeText Edm.String true

OData Services
44 PUBLIC OData API Reference
Navigations

Name FromRole ToRole Cardinality

Appointment AppointmentInvolvedParties TaskAttachmenAppoint­ 1.1

mentt

3.2.3.4 Appointment Notes

Overview

The AppointmentNotes collection provides information about a related appointment.

Top Level Entity

Appointment

Properties

Name Type Nullable Max Length Fixed length

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Text Edm.String true false

TypeCode Edm.String true 5 true

OData Services
OData API Reference PUBLIC 45
TypeCodeText Edm.String true

UpdatedOn Edm.DateTime true

3.2.4 BusinessPartner Entity Type

Overview

BusinessPartnerCollection provides information about all Business Partners i.e. Accounts, Individual Customers,
Contacts, Employees, Competitors, Partners etc.

ThingType property refers to the thing type associated with a business partner instance. ThingType is used for
navigation and displaying data for corresponding Business Partner in the standard UI in SAP Cloud for Customer.
The BusinessPartnerCollection is read-only and can be used to determine the correct entity type referred to in a
party collection based on the Party UUID.

Properties

Name Type Description $search relevant

UUID Edm.Guid Alternative Key of BusinessPart­ Yes

ner

ThingType Edm.String Thing Type used in the UI for the No

particular Business Partner

Mapping

ThingType Related C4C-BuPa-UI Corresponding C4CODATA-EntityType

COD_ACCOUNT_TT Account Account

COD_CONTACT_TT Contact Contact

COD_SEOD_ACCOUNT_TT IndividualCustomer IndividualCustomer

COD_EMPLOYEES Employee Employee

OData Services
46 PUBLIC OData API Reference
ThingType Related C4C-BuPa-UI Corresponding C4CODATA-EntityType

COD_COMPETITOR_TT Competitor Not applicable

COD_PARTNER_TT Partner Not applicable

COD_PARTNERCONTACT_TT PartnerContact Not applicable

3.2.5 CodeList Entity Type

The CodeList Entity Type is a Single EntityType.The EntityGroup description are not required.

3.2.5.1 Codelist

Overview

The Codelist collection provides a list of codes and their corresponding descriptions for a code type collection. It is
automatically added into the service metadata if it contains any properties representing a code type.

It cannot be created, updated or deleted. This is read-only entity.

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Code Edm.String false false

Description Edm.String false false

OData Services
OData API Reference PUBLIC 47
3.2.6 Contextual CodeList Entity Type
The ContextualCodeList Entity Type is a Single Entity Type. The EntityGroup description is not required.

3.2.6.1 Contextual CodeList

Overview

Contextual CodeList collection provides a list of contexts, codes, and their corresponding descriptions.
ContextualCodeList entity type is automatically added into the service metadata, if the service contains any
properties of the type.

Along with Code and Description, ContextualCodeList entity type has a context parameter for which the codes are
relevant. For example, Region in an address is contextual. A Region or State “NY” is relevant both for countries with
country codes: US and GB. If a user has to fetch all region codes of country “US”, corresponding collection has to
be filtered using Context = “US”. If a context is not provided, all the regions in the world shall be returned.

OData Services
48 PUBLIC OData API Reference
Entities cannot be created, updated or deleted in the corresponding entity sets. All entity sets based on
ContextualCodeList shall be read-only. Key of the entity type includes both Code and Context.

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Code Edm.String false false

Context Edm.String false false

Description Edm.String false false

OData Services
OData API Reference PUBLIC 49
3.2.7 Contact Entity Type

The Contact related collections allow you to read and maintain Contacts to Accounts and their personal addresses

3.2.7.1 Contact Attachment

Overview

The ContactAttachment collection provides information about various attachments such as Documents, Images
etc. associated to a particular contact.

OData Services
50 PUBLIC OData API Reference
Top Level Entity

Contact

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

UUID Edm.Guid 36 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

MimeType Edm.String true

Binary Edm.Binary true

DocumentLink Edm.String true

Name Edm.String true

CategoryCode Edm.String false 1 true

CategoryCodeText Edm.String true

LinkWebURI Edm.String true

CreatedOn Edm.DateTime true 21 true

LastUpdatedOn Edm.DateTime true 21 True

CreatedBy Edm.String true 80 true

LastUpdatedBy Edm.String true 80 true

3.2.7.2 Contact

Overview

The Contact collection provides the contact information of a particular account. The Contacts are organized based
on the accounts from where they originate from. A contact can be related to multiple Accounts/Contacts or can be
related to a single account..

OData Services
OData API Reference PUBLIC 51
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/ContactCollection

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

CreationOn Edm.DateTime true 21 true

ChangedOn Edm.DateTime true

21 true

CreatedBy Edm.String true 40 true

ChangedBy Edm.String true 40 true

RoleCode Edm.String true 6 true

StartDate Edm.DateTime false

8 true

EndDate Edm.DateTime false 8 true

ObjectID Edm.String false 70 true

ContactName Edm.String false 480 true true

UUID Edm.Guid true 36 true

ContactID Edm.String true 10 true true

FirstName Edm.String true 240 true true

MiddleName Edm.String true 240 true

LastName Edm.String true 240 true true

AccountID Edm.String true 70 true

AccountUUID Edm.Guid true 36 true

AccountName Edm.String true 480 true true

NickName Edm.String false 240 true

MarketingLeadIndi­ Edm.Boolean true 1 true

cator

AcademicTitleCode Edm.String true 4 true

AcademicTitleCo­ EdmString true

deText

OData Services
52 PUBLIC OData API Reference
AdditionalAcade­ Edm.String true 4 true
micTitleCode

AdditionalAcade­ Edm.String true

micTitleCodeText

ContactPermis­ Edm.String true 1 true

sionCode

ContactPermis­ Edm.String true

sionCodeText

GenderCode Edm.String true 1 true

GenderCodeText Edm.String true

MaritalStatusCode Edm.String true 1 true

MaritalStatusCode­ Edm.String true

Text

VIPContactCode Edm.String true 1 true

VIPContactCode­ Edm.String true

Text

DepartmentCode Edm.String true 4 true

DepartmentCode­ Edm.String true

Text

FunctionCode Edm.String true 4 true

FunctionCodeText Edm.String true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

CategoryCode Edm.String true 1 true

CategoryCodeText Edm.String

StatusCode Edm.String

StatusCodeText Edm.String

LanguageCode Edm.String true 1 true

LanguageCodeText Edm.String

TitleCode Edm.String true 4 true

TitleCodeText Edm.String

OData Services
OData API Reference PUBLIC 53
Navigations

Name From Entity To Entity Cardinality

ContactAttachment Contact ContactAttachment 1 .. *

ContactNotes Contact ContactNotes 1 .. *

ContactBusinessAddress Contact ContactBusinessAddress 1 .. 1

ContactCommunicationData Contact ContactCommunicationData 1.. *

ContactPersonalAddress Contact ContactPersonalAddress 0.. *

3.2.7.3 Contact Notes

Overview

The ContactNotes collection provides information about the notes attached to a particular contact..

Top Level Entity

Contact

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ParentObjectID Edm.String true 70 True

ObjectID Edm.String true

70 True

TypeCode Edm.String true 5 True

LanguageCode Edm.String true 2 true

Text Edm.String false false

CreatedOn Edm.DateTime true

21 true

UpdatedOn Edm.DateTime true 21 true

OData Services
54 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $Search Relevant

CreatedBy Edm.DateTime true

80 True

LastUpdatedBy Edm.String true

80 true

AuthorName Edm.String true 40 True

AuthorUUID Edm.Guid true

36 true

3.2.7.4 Contact Personal Address

Overview

The ContactPersonalAddess collection provides personal address information for a contact. A particular contact
can have multiple personal address and one among them would be the default address.

Top Level Entity

Contact

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 True

ParentObjectID Edm.String true 70 True

UUID Edm.Guid true

36 True

Address Edm.String true 480 True

Email Edm.String true 765 true

Mobile Edm.String true 350 true

Phone Edm.String true 350

true

OData Services
OData API Reference PUBLIC 55
Name Type Nullable Max Length Fixed length $Search Relevant

Fax Edm.String true 350 true

Navigations

Name From Entity To Entity Cardinality

Contact ContactPersonalAddress Contact 1… 1

ContactPersonalAddress ContactPersonalPostalAd­ ContactPersonalPostalAd­ 0…*

dress dress

3.2.7.5 Contact Personal Postal Address

Overview

The ContactPersonalPostalAddress collection provides the postal address associated to a particular contact. There
can be multiple addresses associated to a single contact, and any one of the contact can be marked as the default
address.

Top Level Entity

ContactPersonalAddress

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 True

ParentObjectID Edm.String true 70 True

AdditionalStreet­ Edm.String true 240 True

PrefixName

OData Services
56 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $Search Relevant

AdditionalStreet­ Edm.String true 240 True

SuffixName

CountryCode Edm.String true 3 True

CountryCodeText Edm.String true

POBox Edm.String true 100 true

AddressLine1 Edm.String true 240 true

AddressLine2 Edm.String true

240 true

HouseNumber Edm.String true 100 true

Street Edm.String true

360 True

AddressLine4 Edm.String true

240 true

AddressLine5 Edm.String true 240 True

City Edm.String true

240 true

State Edm.String true

6 True

PostalCode Edm.String true 100 true

PostalCodeText Edm.String true

POBoxPostalCode Edm.String true 100 true

POBoxPostalCode­ Edm.String true

Text

Navigations

Name From Entity To Entity Cardinality

ContactPersonalAddress ContactPersonalPostalAd­ ContactPersonalAddress 1… 1

dress

OData Services
OData API Reference PUBLIC 57
3.2.7.6 Contact Business Address

Overview

The ContactBusinessAddress collection provides information about the accounts related to a particular contact. A
particular contact can be related to many accounts. It also includes the business address referred to by the contact
for a particular account.
.

Top Level Entity

Contact

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 True

PostalAddress Edm.String true

480 True

FirstLineDescrip­ Edm.String true 480 True

tion

SecondLineDe­ Edm.String true 480 True

scription

PreferredCommu­ Edm.String true 3 True

nicationMediumTy­
peCode

UUID Edm.Guid true

36 True

Navigations

Name From Entity To Entity Cardinality

ContactBusinessPostalAd­ ContactBusinesslAddress ContactBusinessPersonalAd­ 1… *

dress dress

OData Services
58 PUBLIC OData API Reference
3.2.7.7 Contact Business Postal Address

Overview

The ContactBusinessPostalAddress collection provides the business/Organization postal address associated to a

particular contact account relationship. There can be multiple postal addresses maintained for a single
relationship, and any one of them can be marked as the default address

Top Level Entity

ContactBusinessAddress

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 True

City Edm.String true

240 True

CountryCode Edm.String true 3 True

CountryCodeText Edm.String true

HouseNumber Edm.String true 100 True

PostalCode Edm.String true 100 True

PostalCodeText Edm.String true

State Edm.String true 6 True

StateText Edm.String true

Street Edm.String true 360 True

OData Services
OData API Reference PUBLIC 59
3.2.7.8 Contact Communication Data

Overview

The ContactCommunicationData collection provides information about the workplace addresses associated with a
particular account and contact relationship. There can be only one workplace address maintained for a particular
relationship

Top Level Entity

Contact

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

ObjectID Edm.String true 70 True

Phone Edm.String true 350 True

EMail Edm.String true 765 True

EMailInvalid Edm.Boolean true 1 True

Fax Edm.String true 350 True

Mobile Edm.String true 350 True

BuildingID Edm.String true 10 True

DepartmentFrom­ Edm.String true 240 True

BusinessCard

FloorID Edm.String true 10 True

JobTitle Edm.String true 240 True

RoomID Edm.String true 10 True

OData Services
60 PUBLIC OData API Reference
Navigations

Name From Entity To Entity Cardinality

AccountContactPersonalRela­ ContactCommunicationData AccountContactRelationship 1… 1

tionship

3.2.8 EMail Entity Type

The Email related collections allow you to read and maintain Email communication done with business partners
and related data such as attachments and recipients

OData Services
OData API Reference PUBLIC 61
3.2.8.1 EMail

Overview

The EMail collection allows you to synchronize and view E-mail communication done with business partners and
associates the E-mail with related objects such as an account, opportunity, lead, or sales quote.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/EmailCollection

Properties

Max
Name Type Nullable Length Fixed length

AccountID Edm.String true 60 true

AccountName c4codata.EN­ true

CRYPTED_LONG_Name

AccountUUID Edm.Guid true

DateTime c4codata.LOCALNOR­ false

MALISED_DateTime

GroupCode Edm.String true 4 true

GroupCodeText Edm.String true

ID Edm.Guid true 35 true

MessageFromPartyID Edm.DateTime true 60 true

MessageFromParty­ c4codata.EN­ true

CRYPTED_LONG_Name
Name

MessageFromPar­ Edm.Guide true

tyUUID

OData Services
62 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length

ObjectID Edm.String true 70 true

OwnerName c4codata.EN­ true

CRYPTED_LONG_Name

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.Guid true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

SubjectName Edm.String true 765 true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

CorrespondenceTrans­ Edm String true 2 true

missionStatusCode

MessageFromEmailURI Edm String true 254 true

MessageFromName Edm String true 255 true

UUID Edm Guid true

Navigations

Name FromRole ToRole Cardinality

EMailAttachment EMail EMailAttachment 1 .. *

EMailCcRecepients EMail EMailCcRecepients 1 .. *

EmailNotes EMail EmailNotes 1 .. *

EMailToRecepients EMail EMailToRecepients 1.. *

OData Services
OData API Reference PUBLIC 63
3.2.8.2 EMail Attachment

Overview

The EMailAttachment collection provides information about attachments in E-mail. For example, attachments of E-
mail associated to an account, opportunity, lead or sales quote is synchronized with SAP Cloud for Customer, and
thereby can be updated and viewed using EMailAttachmentCollection.

Top Level Entity

EMail

Properties

Max
Name Type Nullable Length Fixed length

Binary Edm.Biinary true false

CategoryCode Edm.String false 1 true

CategoryCode­ Edm.String true

Text

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LastUpdatedBy Edm.String true 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID c4codata.EN­ true 70

CRYPTED_LONG_Name

OData Services
64 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length

ParentObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false true

Navigations

Name FromRole ToRole Cardinality

EMailAttachment EMail EMailAttachment 1 .. *

EMailCcRecepients EMail EMailCcRecepients 1 .. *

EmailNotes EMail EmailNotes 1 .. *

EMailToRecepients EMail EMailToRecepients 1.. *

3.2.8.3 EMail Cc Recipients

Overview

The EMailCcRecipients collection provides information about all the Copied Recipients in E-mail.

Top Level Entity

EMail

OData Services
OData API Reference PUBLIC 65
Properties

Name Type Nullable Max Length Fixed length

Address Edm.String true 480 true

EMailID Edm.String true 765 true

Name c4codata.EN­ true

CRYPTED_LONG_Nam
e

ObjectID Edm.Stringe true 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 80 true

PartUUID Edm.Guid true

Phone Edm.String true 350 true

RoleCategoryCode Edm.String true 3 true

MessageCCEMailID Edm String true 254 true

MessageCCName Edm String true 255 true

RoleCategoryText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

EMail EMailCcRecepients EMail * .. 1

3.2.8.4 Email Notes

Overview

The EMailNotes collection provides information about all details in an E-mail.

OData Services
66 PUBLIC OData API Reference
  Note

Notes feature allows you to add and view important information.

Top Level Entity

EMail

Properties

Max
Name Type Nullable Length Fixed length

AuthortName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String false 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectI Edm.String true 70 true

TypeCode Edm.String true false

Text Edm.String true 5 true

TypeCodeText Edm.String true

UpdatedOn Edm.DateTime true

OData Services
OData API Reference PUBLIC 67
3.2.8.5 Email To Recipients

Overview

The EMailToRecipients collection provides information about all “To” Recipients in E-mail.

Top Level Entity

EMail

Properties

Max
Name Type Nullable Length Fixed length

Address Edm.String true 480 true

EMailID Edm.String true 765 true

Name c4codata.EN­ true

CRYPTED_LONG_Name

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60 true

PartyUUID Edm.Guid true

Phone Edm.DateTime true 350 true

RoleCategoryCode Edm.String true 3 true

MessageToEmailID Edm String true 254 true

MessageToName Edm String true 255 true

RoleCategoryCodeText Edm.String true

OData Services
68 PUBLIC OData API Reference
Navigations

Name FromRole ToRole Cardinality

EMail EMailToRecepients EMail * .. 1

3.2.9 Employee Entity Type

The Employee related collections allow you to read and maintain Employees and related data such as their
addresses. Employee entity type is already part of C4CODATA, as a part of clean up duplicate entries from other
entity type of employee such as EmployeeBusinessAddress, EmployeeComminicationData and
EmployeeFormattedBusinessAddress.

Properties

Name Type Description $search relevant

AddressLine1 Edm.String Address Line 1

OData Services
OData API Reference PUBLIC 69
Name Type Description $search relevant

AddressLine2 Edm.String Address Line 2

AddressLine4 Edm.String Address Line 4

AddressLine5 Edm.String Address Line 5

BirthDate Edm.DateTime Date of Birth

BirthName Edm.String Birth Name

BirthPlace Edm.String Birth Place

Building Edm.String Building

CareOfName Edm.String c/o

City Edm.String City

CompanyPostalCode Edm.String CompanyPostalCode

CountryCode Edm.String Country

County Edm.String County

DifferentCity Edm.String Different City

District Edm.String District

EmployeeValidityEndDate Edm.String Employee Validity End Date

EmployeeValidityStartDate Edm.String Employee Validity Start Date

FaxNumber Edm.String Fax

Floor Edm.String Floor

GenderCode Edm.String Gender

HouseNumber Edm.String House Number

InhouseMail Edm.String In-House Mail

LanguageCode Edm.String Language

MaritalStatusCode Edm.String Marital Status

MobilePhoneNumber Edm.String Mobile

NationalityCountryCode Edm.String Nationality

OfficePhoneNumber Edm.String Phone

OData Services
70 PUBLIC OData API Reference
Name Type Description $search relevant

POBox Edm.String P.O. Box

POBoxCity Edm.String P.O. Box City

POBoxCountryCode Edm.String P.O. Box Country

POBoxPostalCode Edm.String P.O. Box Postal Code

POBoxRegionCode Edm.String P.O. Box State

PostalCode Edm.String Postal Code

RegionCode Edm.String State

Room Edm.String Room

SecondLastName Edm.String Second Last Name

Street Edm.String Street

TaxJurisdictionCode Edm.String Tax Jurisdiction Code

UserPasswordPolicyCode Edm.String User Password Policy

UserValidityEndDate Edm.DateTime User Validity End Date

UserValidityStartDate Edm.DateTime User Validity Start Date

3.2.9.1 Employee

Overview

The Employee collection provides details about internal and external employees for an organization. The
Employees have their respective roles assigned and associated to an account, team etc.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/EmployeeCollection

OData Services
OData API Reference PUBLIC 71
Properties

Name Type Nullable Max Length Fixed length

AcademicTitleCode Edm.String true 4 true

AcademicTitleCo­ Edm.String true

deText

DateFormatCode Edm.String true 2 true

DateFormatCode­ Edm.String true

Text

DecimalFormat­ Edm.String true 2

Code

DecimalFormatCo­ Edm.String true

deText

EmployeeID Edm.String true 20 true true

FirstName Edm.String true 240 true

InternalEm­ Edm.Boolean true

ployeeIndicator

InternalID Edm.String false 10 true

LastName Edm.String true 240 true

EndDate Edm.DateTime true

LogonLanguage­ Edm.String true 1 true

Code

LogonLanguageCo­ Edm.String true true

deText

MiddleName Edm.String true 240 true

Name Edm.String false 480 true true

NickName Edm.String true 240 true

ObjectID Edm.String false 70 true

StartDate Edm.DateTime true

SortingName Edm.String true 480 true

TimeFormatCode Edm.String true 2 true

OData Services
72 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

TImeFormatCode­ Edm.String true

Text

TimeZoneCode Edm.String true 10

TimeZoneCodeText Edm.String

TitleCode Edm.String true 4 true

TitleCodeText Edm.String true

UUID Edm.Guid true

UserID Edm.String true 40 true

Navigations

Name FromEntity ToEntity Cardinality

EmployeeBusinessAddress Employee EmployeeBusinessAddress 1 .. *

EmployeeCommunication­ Employee EmployeeCommunication­ 1 .. *

Data Data

3.2.9.2 Employee Business Address

Overview

The EmployeeBusinessAddress collection entity provides details about the organization address of the employees.

Top Level Entity

Employee

OData Services
OData API Reference PUBLIC 73
Properties

Name Type Nullable Max Length Fixed length

City Edm.String true 240 true

CountryCode Edm.String true 3 true

CountryCodeText Edm.String true

HouseNumber Edm.String true 100 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

PostalCode Edm.String true 100 true

PostalCodeText Edm.String true

StateCode Edm.String true 6 true

StateCodeText Edm.String true

Street Edm.String true 360 true

Navigations

Name FromEntity ToEntity Cardinality

Employee EmployeeBusinessAddress Employee * ..1

EmployeeFormattedBusines­ EmployeeBusinessAddress EmployeeFormattedBusines­ 1 .. *

sAddress sAddress

3.2.9.3 Employee Communication Data

Overview

The EmployeeCommunicationData collection entity provides workplace organization details of the employees..

OData Services
74 PUBLIC OData API Reference
Top Level Entity

Employee

Properties

Name Type Nullable Max Length Fixed length

Buildinge Edm.String true 10 true

EMail Edm.String true 765 true

Fax Edm.String true 350 true

Floor Edm.String true 10 true

Mobile Edm.String true 350 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Phone Edm.String true 350 true

Room Edm.String true 10 true

Navigations

Name FromEntity ToEntity Cardinality

Employee EmployeeCommunication­ Employee * ..1

Data

3.2.9.4 Employee Formatted Business Address

Overview

The EmployeeFormattedBusinessAddress collection entity provides the employees business address in a format.

OData Services
OData API Reference PUBLIC 75
Usage Scenario

This is only a read-only entity, and cannot be created or updated. It is created automatically once address is
created.

Top Level Entity

EmployeeBusinessAddress

Properties

Name Type Nullable Max Length Fixed length

FormattedAddress Edm.String true 480 true

ParentObjectID Edm.String false 70 true

ObjectID Edm.String false 70 true

Navigations

Name FromEntity ToEntity Cardinality

EmployeeBusinessAddress EmployeeBusinessFormatte­ EmployeeBusinessAddress * .. 1

dAddress

OData Services
76 PUBLIC OData API Reference
3.2.10 External ID Mapping Entity Type

The External ID Mappping Entity Type is a Single EntityType. The EntityGroup description are not required.

3.2.10.1 External ID Mapping

Overview

The ExternalIDMapping collection entity provides mapping details of a local object identifier corresponding to an
object identifier in a remote system.

Usage Scenario

This is only a read-only entity, and cannot be created or modified.

OData Services
OData API Reference PUBLIC 77
Properties

Name Type Nullable Max Length Fixed length

ExternalID Edm.String true 100 true

ExtneralSystemID Edm.String true 32 true

ExternalSystemUUID Edm.Guid true

ObjectID Edm.String true 70 true

ObjectTypeCode Edm.String true 15 true

ObjectTypeCodeText Edm.String true

3.2.11 Individual Customer Entity Type

The Individual Customer related collections allow you to read and maintain individual customers and their
addresses. Employee entity type is already part of C4CODATA, as a part of clean up duplicate entries from other
entity type of IndividualCustomer such as EmployeeBusinessAddress, EmployeeComminicationData and
EmployeeFormattedBusinessAddress.

OData Services
78 PUBLIC OData API Reference
Properties

Name Type Description $search relevant

BirthDateProtectedIndicator Edm.Boolean Birth Date Protected Indicator

EndDate Edm.DateTime Valid To

MaritalStatusProtectedIndica­ Edm.Boolean Marital Status Protected Indi­

tor cator

StartDate Edm.DateTime Valid From

3.2.11.1 Individual Customer

Overview

The Individual Customer collection provides information about customers who are not associated with a corporate
account, and do business with the company directly.

Such customers can be created, updated and viewed using this collection.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/IndividualCustomerCollection

Properties

Name Type Nullable Max Length Fixed length

ABCClassificationCode Edm.String true 1 true

ABCClassificationCode- Edm.String true

Text

AcademicTitleCode Edm.String true 4 true

OData Services
OData API Reference PUBLIC 79
Name Type Nullable Max Length Fixed length

AcademicTitleCodeText Edm.String true

AdditionalStreetPrefix- Edm.String true 240 true

Name

AdditionalStreetSuffix- Edm.String true 240 true

Name

BillingBlockCode Edm.String true 2 true

BillingBlockCodeText Edm.String true

BuildingID Edm.String true 10 true

CareOfName Edm.String true 240 true

CatagoryCode Edm.String true 1 true

CatagoryCodeText Edm.String true

ContactPermission­ Edm.String true 1 true

Code

ContactPermissionCo­ Edm.String true

deText

CorrespondenceLan­ Edm.String true 1 true

guageCode

CorrespondenceLan­ Edm.String true

guageCodeText

CountryCode Edm.String true 3 true

CountryCodeText Edm.String true

CountyName

CustomerID Edm.String true 10 true

DateOfBirth Edm.DateTime true

DeliveryBlockCode Edm.String true 2 true

DeliveryBlockCodeText Edm.String true

DistrictName Edm.String true 240 true

EMail Edm.String true 765 true

Fax Edm.String true 350 true

OData Services
80 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

FirstName Edm.String true 240 true

GenderCode Edm.String true 1 true

GenderCodeText Edm.String true

HouseID Edm.String true 100 true

Initials Edm.Boolean true 100 true

LanguageCode Edm.String true 1 true

LanguageCodeText Edm.String true

LastName Edm.String false 240 true

MaritalStatusCode Edm.String true 1 true

MaritalStatusCodeText Edm.String true

MarketingLeadIndicator Edm.Boolean true

MiddleName Edm.String true 240 true

Mobile Edm.String true 350 true

Name Edm.String true 480 true

NationalityCode Edm.String true 3 true

NationalityCodeText Edm.String true

Nickname Edm.String true 240 true

ObjectID Edm.String true 70

OrderBlockCode Edm.Guid true 2

OrderBlockCodeText Edm.String true

Owner Edm.String true 480 true

OwnerUUID Edm.String true

OwnerID Edm.String true 10 true

POBoxDeviatingCity­ Edm.String true 240 true

Name

POBoxDeviatingCoun­ Edm.String true 3 true

tryCode

OData Services
OData API Reference PUBLIC 81
Name Type Nullable Max Length Fixed length

POBoxDeviatingCoun­ Edm.String true

tryCodeText

POBoxDeviatingRegion­ Edm.String true 6 true

Code

POBoxDeviatingRegion­ Edm.String true

CodeText

POBoxID Edm.String true 100 true

POBoxPostalCode Edm.String true 100

POBoxPostalCodeText Edm.String true

Phone Edm.String true 350 true

PreferredCommunica­ Edm.String true 3 true

tionMediumTypeCode

PreferredCommunica­ Edm.String true

tionMediumTypeCode­
Text

PrefixCode Edm.String true 4 true

PrefixCodeText Edm.String true

ProfessionCode Edm.String true 4 true

ProfessionCodeText Edm.String true

RegionCode Edm.String true 6 true

RegionCodeText Edm.String true

RoleCode Edm.String true 6 true

RoleCodeText Edm.String true

SalesSupportBlock Edm.Boolean true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

StreetName Edm.String true 360 true

StreetPostalCode Edm.String 100 true

StreetPostalCodeText Edm.String true

OData Services
82 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

StreetPrefixName Edm.String true 240 true

StreetSuffixName Edm.String true 240 true

TaxJurisdictionCode Edm.String true 25 true

TaxJurisdictionCode­ Edm.String true

Text

TimeZoneCode Edm.String true 10 true

TimeZoneCodeText Edm.String true

TitleCode Edm.String true 4 true

TitleCodeText Edm.String true

UUID Edm.String true

Web Edm.String true 1280 true

Navigations

Name FromRole ToRole

IndividualCustomerAttachment IndividualCustomer IndividualCustomerAttachment

IndividualCustomerCommon IndividualCustomer IndividualCustomerCommon

IndividualCustomerNotes IndividualCustomer IndividualCustomerNotes

3.2.11.2 Individual Customer Attachment

Overview

The Individual Customer Attachment collection provides information about customers who are not associated with
a corporate account, and do business with the company directly.

These attachments can be created, updated, and viewed using this collection.

OData Services
OData API Reference PUBLIC 83
Top Level Entity

IndividualCustomer

Properties

Name Type Nullable Max Length Fixed length

Binary Edm.Binary true false

CategoryCode Edm.String false 1

CategoryCodeText Edm.String true true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LastUpdatedBy Edm.String true 80

LastUpdatedOn Edm.DateTime true

LinkWebURI Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 701 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true true

UUID Edm.String false

OData Services
84 PUBLIC OData API Reference
3.2.11.3 Individual Customer Common

Overview

The IndividualCustomerCommon collection provides biographical information of customers.

Top Level Entity

IndividualCustomer

Properties

Name Type Nullable Max Length Fixed length

AcademicTitleCode Edm.String true 4 true

AcademicTitleCodeText Edm.String true

BirthDate Edm.DateTime true

BirthDateProtectedIndi­ Edm.Boolean true

cator

EndDate Edm.DateTime true

GenderCode Edm.String true 1 true

GenderCodeText Edm.String true

GivenName Edm.String true 240 true

MaritalStatusCode Edm.String true 1 true

MaritalStatusCodeText Edm.String true

MaritalStatusProtecte­ Edm.Boolean true

dIndicator

MiddleName Edm.String true 240 true

NationalityCountry­ Edm.String true 3 true

Code

OData Services
OData API Reference PUBLIC 85
Name Type Nullable Max Length Fixed length

NationalityCountryCo­ Edm.String true

deText

NonVerbalCommunica­ Edm.String true 1 true

tionLanguageCode

NonVerbalCommunica­ Edm.String true

tionLanguageCodeText

ObjectID Edm.String true 70 true

OccupationCode Edm.String true 4 true

OccupationCodeText Edm.DateTime true

ParentObjectID Edm.String true 70 true

StartDate Edm.DateTime true

Navigations

Name FromEntity ToEntity Cardinality

IndividualCustomerCommon IndividualCustomerCommon IndividualCustomer 1..*

3.2.11.4 Individual Customer Notes

Overview

The IndividualCustomerNotes collection allows you to add more information about a Customer.

Top Level Entity

IndividualCustomer

OData Services
86 PUBLIC OData API Reference
Properties

Name Type Nullable Max Length Fixed length

AuthorName Edm.Binary true 40 true

AuthorUUID Edm.Guide true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Text Edm.String true false

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true true

UpdatedOn Edm.DateTime true

OData Services
OData API Reference PUBLIC 87
3.2.12 Lead Entity Type

The lead related collections allow you to read and maintain sales leads and related data such as products, parties
involved and business transaction document references.

3.2.12.1 Lead

Overview

The Lead collection(LeanLead) represents an individual or organization that a company has the potential to do
business with and is based on a similar SAP CRM functionality.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeadCollection

OData Services
88 PUBLIC OData API Reference
Attribute Definition

Max
Name Type Nullable Length Fixed length $Search Relevant

ID (ID ) Edm.String true 35 true

Category (Group­ Edm.String true 4 true

Code)

Source (OriginType­ Edm.String true 3 true

Code)

Priority (Priority­ Edm.String true 1 true

Code)

End Date (End Date) Edm.DateTime true true

Start Date (Start Edm.DateTime true true

Date)

Processing Type Edm.String true 4 true

(ProcessingTypeCo­
delea)

Qualification Level Edm.String true 2 true

(QualificationLevel-
Code)

Reason Code (Resul­ Edm.String true 3 true

tReasonCode)

Approval Status (Ap­ Edm.String true 2 true

provalStatusCode)

Consistency Status Edm.String true 2 true

(ConsistencyStatus­
Code)

Survey Score (Sur­ Edm.Int true 32 true

veyTotalScoreValue)

Creation Date Time Edm.DateTimeOffset true 7 true

(CreationDateTime)

Distribution Channel Edm.String true 2 true

(DistributionChannel­
Code)

Division (Division­ Edm.String true 2 true

Code)

OData Services
OData API Reference PUBLIC 89
 Max
Name Type Nullable Length Fixed length $Search Relevant

SalesGroupUUID Edm.Guid true

Sales Group (Sales­ Edm.String true 20 true

GroupID)

SalesOfficeID Edm.Guid true 20 true

SalesOfficeUUID Edm.Guid true

Sales Organisation Edm.String true 20 true

(SalesOrganisationID)

SalesOrganisatio­ Edm.Guid true

nUUID

SalesTerritoryID Edm.String true 6 true

(SalesTerritoryID)

Sales Territory Name Edm.String true 40

(SalesTerritoryName)

Owner Party ID Edm.String true 60 true

(Sales) (OwnerPar­
tyIDSales)

Owner UUID (Sales) Edm.Guid true

(OwnerUUIDSales)

Owner (Sales) (Own­ Edm.String true 480 true

erSalesName)

Marketing Unit Party Edm.String true 60 true

ID (MarketingUnitPar­
tyID)

Marketing Unit Party Edm.Guid true

UUID (MarketingUnit­
PartyUUID)

Marketing Unit Name Edm.Grid true 480

(MarketingUnitName)

Account Party ID (Ac­ Edm.String true 60 true

countPartyID)

Account Party UUID Edm.Guid true

(AccountPartyUUID)

OData Services
90 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

AccountPartyName Edm.String true 480

Main Contact ID Edm.String true 60 true

(ContactID)

Contact UUID (Con­ Edm.Guid true

tactUUID)

Main Contact Name Edm.String true 480

(ContactName)

Owner Party ID (Own­ Edm.String true 60 true

erPartyID)

Owner Party UUID Edm.Guid true

(OwnerPartyUUID)

OwnerPartyName Edm.String true 480

Sales Unit Party ID Edm.String true 60 true

(SalesUnitPartyID)

Sales Unit Party UUID Edm.Guid true

(SalesUnitPartyUUID)

Sales Unit Name Edm.String true 480

(SalesUnitName)

Expected Revenue Edm.Decimal true 28

Value (ExpectedReve­
nueAmount)

Expected Revenue Edm.String true 3 true

Amount Currency
(ExpectedRevenue­
CurrencyCode)

Name (Name) Edm.String 255

Name Language Edm.String true 1 true

Code (NameLangua­
geCode)

Company (Company) Edm.String true 40

Contact First Name Edm.String true 40

(ContactFirstName)

OData Services
OData API Reference PUBLIC 91
 Max
Name Type Nullable Length Fixed length $Search Relevant

ContactLastName Edm.String true 40

Contact Last Name)

Contact Information Edm.String true 40 true

Phone (Contact­
Phone)

Contact Information Edm.String true 40 true

Mobile (ContactMo­
bile)

Contact Information Edm.String true 100 true

E-Mail (ContactEmail)

Customer Informa­ Edm.String true 40 true

tion City (AccountC­
ity)

Customer Informa­ Edm.String true 6 true

tion State (Account­
State)

Customer Informa­ Edm.String true 3 true

tion Country (Ac­
countCountry)

Campaign ID (Cam­ Edm.String true 35 true

paignID)

EmployeeResponsi­ Edm.Guid
bleUUID

Account Information Edm.String true 40 true

Additional Name
(CompanySecond­
Name)

Account Information Edm.String true 40 true

Additional Name 2
(CompanyThird­
Name)

Account Information Edm.String true 40 true

Additional Name 3
(CompanyFourth­
Name)

OData Services
92 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

Account Information Edm.String true 1 true

ABC Classification
(OrganisationAccoun­
tABCClassification­
Code)

Account Information Edm.String true 10

Industry (Organisatio­
nAccountIndustrial­
SectorCode)

Customer Informa­ Edm.String true 1

tion Contact Permis­
sion (OrganisationAc­
countContactAllo­
wedCode)

Contact Middle Name Edm.String true 40

(ContactMiddle­
Name)

Contact Information Edm.String true 1 true

Gender (ContactGen­
derCode)

Contact Information Edm.String true 4 true

Academic Title (Con­
tactAcademicTitle­
Code)

Contact Information Edm.String true 4 true

Additional Academic
Title (ContactAdditio­
nalAcademicTitle­
Code)

Contact Information Edm.String true 1 true

Contact Permission
(ContactAllowed­
Code)

Contact Information Edm.String true 4 true

Title (ContactFormO­
fAddressCode)

OData Services
OData API Reference PUBLIC 93
 Max
Name Type Nullable Length Fixed length $Search Relevant

Contact Information Edm.String true 40

Nickname (Contact­
NickName)

Contact Information Edm.String true 1 true

Marital Status (Con­
tactMaritalStatus­
Code)

Contact Information Edm.String true 4 true

Function (Business­
PartnerRelationship­
BusinessPartner­
FunctionTypeCode)

Contact Information Edm.String true 4 true

Department (Busi­
nessPartnerRelation­
shipBusinessPartner­
FunctionalAreaCode)

Contact Information Edm.String true 100 true

Engagement Score
(BusinessPartnerRe­
lationshipEngage­
mentScoreNumber­
Value)

Contact Information Edm.String true 1 true

VIP Contact (Busi­
nessPartnerRelation­
shipContactVIPRea­
sonCode)

Contact Information Edm.String true 1 true

Language (Contact­
CorrespondenceLan­
guageCode)

Individual Customer Edm.String true 4 true

Information Title (In­
dividualCustomerFor­
mOfAddressCode)

OData Services
94 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

Individual Customer Edm.String true 4 true

Information Aca­
demic Title (Individu­
alCustomerAcade­
micTitleCode)

First Name of Indiv. Edm.String true 40

Customer (Individual­
CustomerGiven­
Name)

Last Name of Indiv. Edm.String true 40

Customer (Individual­
CustomerFamily­
Name)

Middle Name of Indiv. Edm.String true 40

Customer (Individual­
CustomerMiddle­
Name)

Individual Customer Edm.String true 1 true

Information Gender
(IndividualCustomer­
GenderCode)

Individual Customer Edm.String true 1 true

Information Contact
Permission (Individu­
alCustomerContac­
tAllowedCode)

Individual Customer Edm.String true 1 true

Information Marital
Status (Individual­
CustomerMaritalSta­
tusCode)

Individual Customer Edm.String true 1 true

Information ABC
Classification (Indi­
vidualCustomerABC­
ClassificationCode)

OData Services
OData API Reference PUBLIC 95
 Max
Name Type Nullable Length Fixed length $Search Relevant

Individual Customer Edm.String true 3 true

Information National­
ity (IndividualCusto­
merNationalityCoun­
tryCode)

Individual Customer Edm.DateTime true true

Information Date of
Birth (IndividualCus­
tomerBirthDate)

Individual Customer Edm.String true 4 true

Information Profes­
sion (IndividualCusto­
merOccupationCode)

Individual Customer Edm.String true 100

Information Initials
(IndividualCustomerI­
nitialsName)

Individual Customer Edm.String true 4 true

Information Prefix (In­
dividualCustomerNa­
mePrefixCode)

Individual Customer Edm.String true 1 true

Information Language
(IndividualCustomer­
NonVerbalCommuni­
cationLanguage­
Code)

Individual Customer Edm.String true 40

Information Phone
(IndividualCustomer­
Phone)

Individual Customer Edm.String true

Information E-Mail
(IndividualCusto­
merEMail)

Individual Customer Edm.String true 40

Information Mobile
(IndividualCustomer­
Mobile)

OData Services
96 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

Individual Customer Edm.String true 10

Information Postal
Code (AccountPosta­
lAddressElements­
StreetPostalCode)

Account Information Edm.String true 40

County (AccountPos­
talAddressElements­
CountyName)

Account Information Edm.String true 40

Address Line 1 (Ac­
countPostalAddres­
sElementsStreetPre­
fix)

Account Information Edm.String true 40

Address Line 2 (Ac­
countPostalAddres­
sElementsAdditional­
StreetPrefixName)

Individual Customer Edm.String true 60

Information Street
(AccountPostalAd­
dressElementsStreet­
Name)

Account Information Edm.String true 40

Address Line 4 (Ac­
countPostalAddres­
sElementsStreetSu­
fix)

Account Information Edm.String true 40

Address Line 5 (Ac­
countPostalAddres­
sElementsAdditional­
StreetSuffixName)

Account Information Edm.String true 10 true

House Number (Ac­
countPostalAddres­
sElementsHouseID)

OData Services
OData API Reference PUBLIC 97
 Max
Name Type Nullable Length Fixed length $Search Relevant

Account Information Edm.String true 10 true

P.O.Box (AccountPos­
talAddressElement­
sPOBoxID)

Account Information Edm.String true 40

Phone (Account­
Phone)

Account Information Edm.String true

E-Mail (AccountE­
Mail)

Account Information Edm.String true 40

Mobile (AccountMo­
bile)

Account Information Edm.String true 40

Fax (AccountFax)

Account Information Edm.String true

Web Site (Account­
Website)

AccountLatitudeMea­ Edm.String true 3 true

sureUnitCode

Account Information Edm.Decimal true 31

Latitude (AccountLa­
titudeMeasure)

AccountLongitude­ Edm.String true 3 true

MeasureUnitCode

Account Information Edm.Decimal true 31

Longitude (Accoun­
tLongitudeMeasure)

Account Information Edm.String true 1 true

Language (Account­
CorrespondenceLan­
guageCode)

AccountPreferred­ Edm.String true 3 true

CommunicationMe­
diumTypeCode

OData Services
98 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

Contact Information Edm.String true 40

Job Title (Contact­
FunctionalTitleName)

Contact Information Edm.String true 40

Department from
Business Card (Con­
tactDepartment­
Name)

Contact Information Edm.String true 1 true

E-Mail Invalid (Con­
tactEMailUsageDe­
niedIndicator)

Contact Information Edm.String true 40

Fax (ContactFacsimi­
leFormattedNumber­
Description)

Contact Information Edm.String true 10 true

Building (Contact­
BuildingID)

Contact Information Edm.String true 10 true

Floor (Contact­
FloorID)

Contact Information Edm.String true 10 true

Room (ContactRoo­
mID)

Account Information Edm.String true 2 true

Legal Form (Accoun­
tLegalForm)

Account Information Edm.String true 60

D-U-N-S (Account­
DUNS)

Note (Note) Edm.String true

Account Information Edm.String true

Note (ORG_AC­
COUNT_NOTES)

OData Services
OData API Reference PUBLIC 99
 Max
Name Type Nullable Length Fixed length $Search Relevant

Contact Information Edm.String true

Note (ContactNote)

Navigation

Name From Entity To Entity Cardinality

LeanLeadAttachmentFolder LeanLead LeanLeadAttachmentFolder 0.. *

LeanLeadSalesAndMarketing­ LeanLead LeanLeadSalesAndMarketing­ 0.. *

Team Team

LeanLeadExternalParty LeanLead LeanLeadExternalParty 0.. *

LeanLeadItem LeanLead LeanLeadItem 0.. *

LeanLeadContact LeanLead LeanLeadContact 0.. *

LeanLeadBusinessTransac­ LeanLead LeanLeadBusinessTransac­ 0.. *

tionDocumentReference tionDocumentReference

3.2.12.2 Lead Attachment

Overview

The LeanLeadAttachmentFolder collection provides information about existing attached documents in the Leads.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeanLeadAttachmentFolderCollection

Attribute Definition

Name Type Nullable Max Length Fixed Length $Search Relevant

Binary Edm.String true false

CatagoryCode Edm.String false 1 true

OData Services
100 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed Length $Search Relevant

CatagoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true

LastUpdatedBy Edm.String false 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

PrimaryObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

3.2.12.3 Lead Business Document Relationship

Overview

The LeanLeadBusinessTransactionDocumentReference collection provides information about business document

references for leads.

Top Level Entity

LeanLead

OData Services
OData API Reference PUBLIC 101
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeanLeadBusinessTransactionDocumentReference

Collection

Properties

Name Type Nullable Max Length Fixed Length $Search Relevant

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

ID Edm.String true 35

TypeCode Edm.String true 15 true

UUID Edm.String true true

ItemID Edm.String true 10 true

ItemTypeCode Edm.String true 5 true

ItemUUID Edm.Guid true

BusinessTransac­ Edm.String true 3 true

tionDocumentRela­
tionshipRoleCode

Notifications

Name FromEntity ToEntity Cardinality

LeanLead LeanLeadBusinessTransac­ LeanLead 1 .. 1

tionDocumentReference

Appointment LeanLeadBusinessTransac­ Appointment 1 .. 1

tionDocumentReference

PhoneCall LeanLeadBusinessTransac­ PhoneCall 1 .. 1

tionDocumentReference

EMail LeanLeadBusinessTransac­ EMail 1 .. 1

tionDocumentReference

Task LeanLeadBusinessTransac­ Task 1 .. 1

tionDocumentReference

OData Services
102 PUBLIC OData API Reference
3.2.12.4 Lead Involved Parties

Overview

The LeanLeadInvolvedParties collection provides information about involved parties in the leads.

Top Level Entity

LeanLead

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeanLeadExternalPartyCollection

Properties

Name Type Nullable Max Length Fixed Length $Search Relevant

EMail Edm.String true 765 true

Mobile Edm.String true 350 true

PartyName Edm.String true 480

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60

PartyUUID Edm.String true

Phone Edm.String true 350 true

MainIndicator Edm.String true

MainPartyContact­ Edm.String true 60 true

PartyID

MainPartyContact­ Edm.String true

PartyName

OData Services
OData API Reference PUBLIC 103
Name Type Nullable Max Length Fixed Length $Search Relevant

MainPartyContact­ Edm.String true

PartyUUID

RoleCode Edm.String true 10 true

Navigation

Name FromEntity ToEntity Cardinality

LeanLead LeanLeadExternalParty LeanLead 1 .. 1

3.2.12.5 Lead Sales and Marketing Team

Overview

The LeanLeadSalesAndMarketingTeam collection provides information about sales and marketing team of leads.

Top Level Entity

LeanLead

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeanLeadSalesAndMarketingTeamCollection

Properties

Name Type Nullable Max Length Fixed Length $Search Relevant

EMail Edm.String true 765 true

Mobile Edm.String true 350 true

PartyName Edm.String true

ObjectID Edm.String false 70 true

OData Services
104 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed Length $Search Relevant

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60

PartyUUID Edm.Guidt true

Phone Edm.String true 350 true

MainIndicator Edm.String true

RoleCode Edm.String true 10 true

Navigations

Name FromEntity ToEntity Cardinality

LeanLead LeanLeadSalesAndMarketing­ LeanLead 1 .. 1

Team

3.2.12.6 Lead Product

Overview

The LeanLeadItem collection provides information about products in the Leads.

Top Level Entity

LeanLead

Properties

Name Type Nullable Max Length Fixed Length $Search Relevant

ProductCategory­ Edm.String true 80

Description

ProductCategor­ Edm.String true 20 true

yInternalID

Description Edm.String true 40

OData Services
OData API Reference PUBLIC 105
Name Type Nullable Max Length Fixed Length $Search Relevant

ID Edm.String true 10 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

ProductID Edm.String true 60

Quantity Edm.Decimal true 31

unitCode Edm.String True 3

Navigations

Name FromEntity ToEntity Cardinality

LeanLead LeanLeadItem LeanLead 1 .. 1

3.2.12.7 Lead Contact

Overview

The LeanLeadContact collection provides information about all the contacts related to an account of the lead. This
collection cannot be created using OData service. There is a main single contact and multiple contacts for an
opportunity.

Top Level Entity

LeanLead

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeanLeadContactCollection

OData Services
106 PUBLIC OData API Reference
Properties

Name Type Nullable Max Length Fixed Length

PartyID Edm.String false 1 true

PartyUUID Edm.UUID true false

EMail Edm.String true 80 true

Mobile Edm.DateTime true

PartyName Edm.String true 80 true

ObjectID Edm.DateTime true

Phone Edm.String true false

MainIndicator Edm.Boolean true false

Navigations

Name FromEntity ToEntity Cardinality

LeanLead LeanLead_LeanLeadContact LeanLead 1 .. 1

OData Services
OData API Reference PUBLIC 107
3.2.13 Sales Lead Entity Type (Deprecated)

The Sales Lead related collections allow you to read and maintain Sales Leads and related data such as products,
parties involved and business transaction document references.

3.2.13.1 Sales Lead (Deprecated)

Overview

The Sales Lead collection provides information about existing Sales Leads.

OData Services
108 PUBLIC OData API Reference
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/LeadCollection

Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

AccountID Edm.String true 60 true

AccountName c4codata.EN­ true

CRYPTED_LONG_Na
me

AccountUUID Edm.Guid true

CatagoryCode Edm.String true 4 true

CatagoryCodeText Edm.String true

ChangedBy Edm.String true 480 true

ChangedByUUID Edm.Guid true

ChangedOn Edm.DateTime true

ConversionStatus­ Edm.String true 2 true

Code

ConversionStatusCo­ Edm.String true

deText

CreatedBy Edm.String true 480 true

CreatedByUUID Edm.Guide true

CreatedOn Edm.DateTimeOffset true

EndDate Edm.DateTime true

LeadConsistancy­ Edm.String false 2 true

Code

LeadConsistancyCo­ Edm.String true

deText

OData Services
OData API Reference PUBLIC 109
 Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

LeadID Edm.String true 35 true true

MarketingOwnerFor­ Edm.String true 480 true

mattedName

MarketingOwnerID Edm.String true 60 true

MarketingOwnerUUID Edm.Guid true

MarketingOwnerFor­ Edm.String true 480 true

mattedName

MarketingUnitUUID Edm.Guid false

Name c4codata.EX­ false

TENDED_Name

ObjectID Edm.String false 70 true

PrimaryContactUUID Edm.Guid true

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.String true

ProcessingDatePer­ c4co­ true

iod data.CLOSED_Date­
Period

QualificationLevel- Edm.String true 2 true

Code

QualificationLevelCo- Edm.String true

deText

ReasonForStatus­ Edm.String false 2 true

Code

ReasonForStatusCo­ Edm.String true

deText

SalesOwnerID Edm.String true 60 true

SalesOwnerUUID Edm.Guid true

SalesTerritoryID Edm.String true 6 true

SalesTerritoryUUID Edm.Guid true

OData Services
110 PUBLIC OData API Reference
 Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

SalesUnitID Edm.String true 60 true

SalesUnitUUID Edm.Guid true

SourceCode Edm.String true 3 true

SourceCodeText Edm.String true

StartDate Edm.DateTime true

StatusCode Edm.String false 2 true

StatusCodeText Edm.String true

UUID Edm.Guid true

Navigations

Name FromEntity ToEntity Cardinality

LeadAttachment Lead LeadAttachment 1 .. *

LeadBusinessDocumentRefer­ Lead LeadBusinessDocumentRefer­ 1 .. *

ence ence

LeadInvolvedParties Lead LeadInvolvedParties 1 .. *

LeadProduct Lead LeadProduct 1 .. *

LeadSalesAndMarketingTeam Lead LeadSalesAndMarketingTeam 1 .. *

3.2.13.2 Sales Lead Attachment (Deprecated)

Overview

The LeadAttachment collection provides information about existing attached documents in Sales Leads.

OData Services
OData API Reference PUBLIC 111
Top Level Entity

Lead

Properties

Max
Name Type Nullable Length Fixed length $Search Relevant

Binary Edm.String true false

CatagoryCode Edm.String false 1 true

CatagoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true

LastUpdatedBy Edm.String false 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String ture 70 true

PrimaryObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

OData Services
112 PUBLIC OData API Reference
3.2.13.3 Sales Lead Business Document Reference
(Deprecated)

Overview

The LeadBusinessDocumentReference collection provides information about business document references for
Sales Leads.

Top Level Entity

Lead

Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

ID Edm.String true 35

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true true

UUID Edm.String true true

ItemID Edm.String true 10 true

ItemTypeCode c4codata.EN­ true 5 true

CRYPTED_LONG_Na
me

ItemTypeCodeText Edm.String true

ItemUUID Edm.Guid true

OData Services
OData API Reference PUBLIC 113
 Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

BusinessTransaction­ Edm.String true 3 true

DocumentRelation­
shipRoleCode

BusinessTransaction­ Edm.String true

DocumentRelation­
shipRoleCodeText

Navigations

Name FromEntity ToEntity Cardinality

Lead LeadBusinessDocumentRefer­ Lead 1 .. 1

ence

Lead LeadBusinessDocumentRefer­ Opportunity 1 .. 1

ence

Lead LeadBusinessDocumentRefer­ Appointment 1 .. 1

ence

Lead LeadBusinessDocumentRefer­ EMail 1 .. 1

ence

Lead LeadBusinessDocumentRefer­ PhoneCall 1 .. 1

ence

3.2.13.4 Sales Lead Involved Parties (Deprecated)

Overview

The LeadInvolvedParties collection provides information about involved parties in Sales Leads.

Top Level Entity

Lead

OData Services
114 PUBLIC OData API Reference
Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

EMail Edm.String true 765 true

Mobile Edm.Strin true 350 true

Name c4codata.EN­ true

CRYPTED_LONG_Na
me

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60

PartyUUID Edm.Guidt true

Phone Edm.String true 350 true

Primary Edm.String true

PrimaryContactID Edm.String true 60 true

PrimaryContactName c4codata.EN­ true

CRYPTED_LONG_Na
me

PrimaryContactUUID Edm.String true

RoleCode Edm.String true 10 true

RoleCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

Lead LeadInvolvedParties Lead 1 .. 1

OData Services
OData API Reference PUBLIC 115
3.2.13.5 Sales Lead Product (Deprecated)

Overview

The LeadProduct collection provides information about products in Sales Leads.

Top Level Entity

Lead

Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

Category c4codata.ME­ true

DIUM_Description

CategoryID Edm.String true 20 true

Description Edm.String true

ID c4codata.SHORT_De­ true 10 true

scription

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

ProductID Edm.String true 60

Quantity c4codata.Quantity true

OData Services
116 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

Lead LeadProduct Lead 1 .. 1

3.2.13.6 Lead Sales and Marketing (Deprecated)

Overview

The LeadSalesAndMarketingTeam collection provides information about Sales and Marketing team of Sales Leads.

Top Level Entity

Lead

Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

Email Edm.String true 765 true

Mobile Edm.Strin true 350 true

Name c4codata.EN­ true

CRYPTED_LONG_Na
me

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60

PartyUUID Edm.Guidt true

OData Services
OData API Reference PUBLIC 117
 Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

Phone Edm.String true 350 true

Primary Edm.String true

RoleCode Edm.String true 10 true

RoleCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

Lead LeadInvolvedParties Lead 1 .. 1

3.2.14 Opportunity Entity Type

The Opportunity related collections allow you to read and maintain Opportunities and related data such as
products, sales teams and parties involved and sales activities performed.

OData Services
118 PUBLIC OData API Reference
3.2.14.1 Opportunity

Overview

The Opportunity collection provides information about all opportunities, and these opportunities represent
potential sales. They can be displayed, edited, and even new ones can be created. Opportunities that are converted
from Lead can also be edited.

Properties

Name Type Nullable Max Length Fixed length

AccountID Edm.String true 60 true

AccountName Edm.String true

AccountUUID true

ApprovalStatusCode Edm.String true 2

ApprovalStatusCode­
Text

CatagoryCode Edm.String true 4 true

CatagoryCodeText Edm.String true

ChangedBy Edm.String true 480 true

ChangedByUUID Edm.Guid true

ChangedOn Edm.DateTime true

CloseDate Edm.DateTime true

ConsistencyStatus­ Edm.String true

Code

ConsistencyStatusCo­ Edm.String true 2

deText

CreatedByFormatted­ Edm.String true 480

Name

CreatedByUUID Edm.String true

OData Services
OData API Reference PUBLIC 119
Name Type Nullable Max Length Fixed length

CreatedOn Edm.DateTime true

CustomStatusCode Edm.String true 5 true

CustomStatusCodeText Edm.String true

DistributionChannel­ Edm.String true 2 true

Code

DistributionChannelCo­ Edm.String true

deText

DivisionCode Edm.String true 2 true

DivisionCodeText Edm.String true

DocumentTypeCode Edm.String true 4 true

DocumentTypeCode­ Edm.String true

Text

ExpectedValue false

ForcastCatagoryCode Edm.String true 4 true

ForcastCatagoryCode­ Edm.String true

Text

LastChangeDate Edm.DateTime true

Name false

ObjectID Edm.String false 70 true

OpportunityID Edm.String true 35 true

OwnerID Edm.String true 60 true

OwnerName true

OwnerUUID Edm.Guid true

PrimaryContactID Edm.Sraing

PrimaryContactName c4codata.EN­ false

CRYPTED_LONG_Nam
e

PrimaryContactUUID Edm.Guid true

PriorityCode Edm.String true 1 true

OData Services
120 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

PriorityCodeText Edm.String true

ProbabilityPercent Edm.Decimal true

ProgressCode Edm.String true 2 true

ProgressCodeText Edm.String true

PublishToForcast Edm.Boolean true

ReasonForStatusCode Edm.DateTime true 3 true

ReasonForStatusCode­ Edm.String true

Text

SalesCycleCode Edm.String true 3 true

SalesCycleCodeText Edm.String

SalesGroupID Edm.String true 20 true

SalesOfficeID Edm.String true 20 true

SalesOrganisationID Edm.String true 20 true

SalesOrganisationUUID Edm.Guid true

SalesPhaseCode Edm.String true 3 true

SalesPhaseCodeText Edm.String true

SalesTerritoryID Edm.String true 6 true

SalesTerritoryUUID Edm.Guid true

SalesUnitID Edm.String true 60 true

SalesUnitUUID Edm.Guid true

SourceCode Edm.String true 3 true

SourceCodeText Edm.String true

StartDate Edm.StartDate true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

TotalNegotiatedValue Edm.String false

OData Services
OData API Reference PUBLIC 121
Name Type Nullable Max Length Fixed length

UUID Edm.Guid false

WeightedValue Edm.String false

Navigations

Name FromRole ToRole

OpportunityAppointmentSalesActivity Opportunity OpportunityAppointmentSalesActivity

OpportunityAttachment Opportunity OpportunityAttachment

OpportunityContact Opportunity OpportunityContact

OpportunityEmailSalesActivity Opportunity OpportunityEmailSalesActivity

OpportunityInvolvedParties Opportunity OpportunityInvolvedParties

OpportunityNotes Opportunity OpportunityNotes

OpportunityPhoneCallSalesActivity Opportunity OpportunityPhoneCallSalesActivity

OpportunitySalesTeam Opportunity OpportunitySalesTeam

OpportunityTaskSalesActivity Opportunity OpportunityTaskSalesActivity

3.2.14.2 Opportunity Appointment Sales Activity

Overview

The OpportunityAppointmentSalesActivity collection provides information about all the sales activities of
opportunities, and these opportunities represent potential sales. These are the activities which are created in order
to follow up with Opportunities. These activities include Appointments, Tasks, PhoneCalls, and E-mails.

Top Level Entity

Opportunity

OData Services
122 PUBLIC OData API Reference
Properties

Max
Name Type Nullable Length Fixed length

DueDateTime c4codata.LOCALNOR­ true

MALISED_DateTime

ID Edm.String true 35

ObjectID Edm.String true 70 true

OwnerID Edm.String true 60 true

BusinessTransaction­ Edm.String true 3 true

DocumentRelationshi­
pRoleCode

BusinessTransaction­ Edm.String
DocumentRelationshi­
pRoleCodeText

OwnerName c4codata.EN­ true

CRYPTED_LONG_Na
me

OwnerUUID Edm.Guid

ParentObjectD Edm.String true 70 true

SalesPhaseCode Edm.String true 3 true

SalesPhaseCodeText Edm.String true

StartDateTime Edm.DateTimeOffset true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

Subject Edm.String true 765 true

TypeCode Edm.String true 12 true

TypeCodeText Edm.String true

UUID Edm.Guid true

OData Services
OData API Reference PUBLIC 123
Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityAppointmentSale­ Opportunity 1..*

sActivity

3.2.14.3 Opportunity Attachment

Overview

The OpportunityAttachment collection provides information about all the attachments for opportunities, and these
opportunities represent potential sales. The attachments can be links, images, etc.

Top Level Entity

Opportunity

Properties

Max
Name Type Nullable Length Fixed length

Binary Edm.Binary true false

CategoryCode Edm.String true 1 true

CategoryCodeText Edm.String true 60 true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime

DocumentLink Edm.String true

LastUpdatecBy Edm.String true 80 true

LastUpdatedOn Edm.DateTime true

OData Services
124 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectD Edm.String true 70 true

ParentObjectD Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true false

UUID Edm.Guid false

3.2.14.4 Opportunity Contact

Overview

The OpportunityContact collection provides information about all the contacts related to an Account of the
Opportunity, and these opportunities represent potential sales. This collection cannot be created using OData
service. There is a main single contact and multiple contacts for an opportunity.

Top Level Entity

Opportunity

Properties

Name Type Nullable Max Length Fixed length

Address Edm.Binary true false

ContactID Edm.String false 1 true

OData Services
OData API Reference PUBLIC 125
Name Type Nullable Max Length Fixed length

ContactUUID Edm.UUID true false

EMail Edm.String true 80 true

Mobile Edm.DateTime

Name Edm.String true 80 true

ObjectID Edm.DateTime true

Phone Edm.String true false

PrimaryContact Edm.Boolean true false

RoleCode Edm.DateTIme true false

RoleCodeText Edm.String true 70 true

3.2.14.5 Opportunity Email Sales Activity

Overview

The OpportunityEmailSalesActivity collection provides information about all the e-mail activities created in order to
follow up with the Opportunity.

Top Level Entity

Opportunity

Properties

Nulla­
Name Type ble Max Length Fixed length

ID Edm.Guid true

OData Services
126 PUBLIC OData API Reference
 Nulla­
Name Type ble Max Length Fixed length

ObjectID Edm.String true 70 true

OwnerID Edm.String true 60 true

OwnerName c4codata.EN­ true

CRYPTED_LONG_Nam
e

OwnerUUID Edm.Guid

ParentObjectD Edm.String true 70 true

SalesPhaseCode Edm.String true 3 true

SalesPhaseCodeText Edm.String true

StartDateTime Edm.DateTimeOffset true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

Subject Edm.String true 765 true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

UUID Edm.Guid true

Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityEmailSalesActiv­ Opportunity 1..*

ity

OData Services
OData API Reference PUBLIC 127
3.2.14.6 Opportunity Involved Parties

Overview

The OpportunityInvolvedParties collection provides information about all the parties involved in the Opportunity. A
Party can be an employee/organization, who is involved in the Opportunity. They can be a business partner
pertaining to a specialized business Objects, Customer, Supplier, or an Employee. It can also be an organizational
center in the specialized business objects of FunctionalUnit.

Top Level Entity

Opportunity

Properties

Max
Name Type Nullable Length Fixed length

Address Edm.String true 480 true

Email Edm.String true 765 true

Mobile Edm.String true 350 true

Name c4codata.EN­ true 70

CRYPTED_LONG_Na
me

ObjectID Edm.String true 70 true

ParentObjectD Edm.String true 70 true

PartyID Edm.String true 60 true

PartyUUID Edm.Guid true

Phone Edm.String true 350 true

Primary Edm.Boolean true

PrimaryContactID Edm.String true 60 true

OData Services
128 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length

PrimaryContactName c4codata.EN­ true

CRYPTED_LONG_Na
me

PrimaryContactUUID Edm.String true

RoleCode Edm.String true 10 true

RoleCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityInvolvedParties Opportunity 1..*

3.2.14.7 Opportunity Notes

Overview

The OpportunityNotes collection provides information about all the text collections or the notes related to an
Opportunity. Examples of text types include explanation texts, internal comments, and shipping instructions.

Top Level Entity

Opportunity

OData Services
OData API Reference PUBLIC 129
Properties

Name Type Nullable Max Length Fixed length

ParentObjectID Edm.String true 70 true

ObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

LanguageCode Edm.String true 2 true

Text Edm.String false false

CreatedOn Edm.DateTime true 21 true

UpdatedOn Edm.DateTime true 21 true

CreatedBy Edm.DateTime true 80 true

LastUpdatedBy Edm.String true 80 true

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true 36 true

LanguageCodeText Edm.String true

3.2.14.8 Opportunity Phone Call Sales Activity

Overview

The OpportunityContact collection provides information about all the contacts related to an Account of the
Opportunity, and these opportunities represent potential sales. This collection cannot be created using OData
service. There is a main single contact and multiple contacts for an opportunity.

Top Level Entity

Opportunity

OData Services
130 PUBLIC OData API Reference
Properties

Nulla­
Name Type ble Max Length Fixed length

ID Edm.Guid true

ObjectID Edm.String true 70 true

BusinessTransaction­ Edm.String true 3 true

DocumentRelationshi­
pRoleCode

BusinessTransaction­ Edm.String
DocumentRelationshi­
pRoleCodeText

OwnerID Edm.String true 60 true

OwnerName c4codata.EN­ true

CRYPTED_LONG_Nam
e

OwnerUUID Edm.Guid

ParentObjectD Edm.String true 70 true

SalesPhaseCode Edm.String true 3 true

SalesPhaseCodeText Edm.String true

StartDateTime Edm.DateTimeOffset true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

Subject Edm.String true 765 true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

UUID Edm.Guid false

OData Services
OData API Reference PUBLIC 131
Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityPhoneCallSale­ Opportunity 1..*

sActivity

3.2.14.9 Opportunity Product

Overview

The OpportunityProduct collection provides information about all the items/products of an Opportunity. An item is
a possibility of selling a quantity of a product or service. It contains product information, quantity, and values.

Top Level Entity

Opportunity

Properties

Max
Lengt
Name Type Nullable h Fixed length

Description c4codata.SHORT_De­ false

scription

ID Edm.Stringe true 10 true

NegotiatedValue c4codata.Amount false

ObjectID Edm.String true 70 true

ParentObjectD Edm.String true 70 true

ProductCategoryDe­ c4codata.ME­ false

DIUM_Description
scription

OData Services
132 PUBLIC OData API Reference
 Max
Lengt
Name Type Nullable h Fixed length

ProductCategoryID Edm.String true 20 true

ProductDescriptione c4codata.SHORT_De­ false

scription

ProductID Edm.String true

ProductUUID Edm.Guid true

ProposedValue c4codata.Amount false

Quantity c4codata.Quantity false

RevenueEndDate Edm.DateTime true

RevenueStartDate Edm.DateTime true

Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityProduct Opportunity 1..*

OpportunityProductNotes OpportunityProduct OpportunityProductNotes 1..*

3.2.14.10 Opportunity Product Notes

Overview

The OpportunityProductNotes collection consists of all natural-language texts that refers to an item in an
Opportunity.

Top Level Entity

Opportunity

OData Services
OData API Reference PUBLIC 133
Properties

Name Type Nullable Max Length Fixed length

ParentObjectID Edm.String true 70 true

ObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

LanguageCode Edm.String true 2 true

Text Edm.String false false

CreatedOn Edm.DateTime true 21 true

UpdatedOn Edm.DateTime true 21 true

CreatedBy Edm.DateTime true 80 true

LastUpdatedBy Edm.String true 80 true

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true 36 true

LanguageCodeText Edm.String true

3.2.14.11 Opportunity Sales Team

Overview

The OpportunitySalesTeam collection specifies a party working on an Opportunity as part of the Sales Team.

Top Level Entity

Opportunity

OData Services
134 PUBLIC OData API Reference
Properties

Max
Name Type Nullable Length Fixed length

Email Edm.String true 765 true

FormattedName c4codata.EN­ true

CRYPTED_LONG_Na
me

Main Edm.Boolean true

ObjectID Edm.String true 70 true

ParentObjectD Edm.String true 70 true

PartyUUID Edm.Guid true

Phone Edm.String true 350 true

RoleCode Edm.String true

RoleCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunitySalesTeam Opportunity 1..*

3.2.14.12 Opportunity Tasks Sales Activity

Overview

The OpportunityTasksSalesActivity collection provides information about all the task activities created in order to
follow up with the Opportunity..

OData Services
OData API Reference PUBLIC 135
Top Level Entity

Opportunity

Properties

Nulla­
Name Type ble Max Length Fixed length

DueEndDateTime c4codata.LOCALNOR­ true

MALISED_DateTime

ID Edm.Guid true

ObjectID Edm.String true 70 true

OwnerID Edm.String true 60 true

OwnerName c4codata.EN­ true

CRYPTED_LONG_Nam
e

OwnerUUID Edm.Guid

ParentObjectD Edm.String true 70 true

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.String

SalesPhaseCode Edm.String true 3 true

SalesPhaseCodeText Edm.String true

StartDateTime Edm.DateTimeOffset true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

Subject Edm.String true 765 true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

UUID Edm.Guid true

OData Services
136 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

Opportunity OpportunityTasksSalesActiv­ Opportunity 1..*

ity

3.2.15 Phone Call Entity Type

The PhoneCall related collections allow you to read and maintain information about PhoneCalls with business
partners and participants in those phone calls.

3.2.15.1 Phone Call

Overview

The PhoneCall collection allows you to track and document your phone calls with business partners.

OData Services
OData API Reference PUBLIC 137
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/PhoneCallCollection

Properties

Name Type Nullable Max Length Fixed length $Search Relevant

AccountFormatted­ c4codata.EN­ false

Name CRYPTED_LONG_N
ame

AccountUUID Edm.Guid true

CampaignDescrip­ c4codata.ME­ false

tion DIUM_Description

CampaignUUID Edm.Guid true

CatagoryCode Edm.String true 4 true

CatagoryCodeText Edm.Decimal true

CreatedByFormat­ Edm.String true 480

tedName

CreatedByUUID Edm.Guid true

CreatedOn Edm.DateTimeOff- true

set

DateTime c4codata.LOCAL­ true

NORMALISED_Da­
teTime

DirectionCode Edm.String true 1

DirectionCodeText Edm.String true

ID Edm.String true 35 true true

ObjectID Edm.String true 70 true

OwnerFormatted­ c4codata.EN­ false

Name CRYPTED_LONG_N
ame

OData Services
138 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $Search Relevant

OwnerUUID Edm.Guid true

Phone Edm.String true 350 true

PrimaryContact­ c4codata.EN­ false

CRYPTED_LONG_N
FormattedName
ame

PrimaryContac­ Edm.Guid true

tUUID

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.String true

ResponseOption­ c4codata.ME­ false

Description DIUM_Description

ResponseOptionID Edm.String true 10 true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

SubjectName Edm.String true 765 true true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

PhoneCallNotes PhoneCall PhoneCallNotes 1..*

PhoneCallParticipants PhoneCall PhoneCallParticipants 1..*

PhoneCallAttachment PhoneCall PhoneCallAttachment 1..*

OData Services
OData API Reference PUBLIC 139
3.2.15.2 Phone Call Attachment

Overview

The PhoneCallAttachment collection provides information about the existing attached documents of a Phone Call.

Top Level Entity

Phone Call

Properties

Max
Name Type Nullable Length Fixed length $Search Relevant

Binary Edm.Binary true false

CategoryCode Edm.String false 1 true

CategoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LastUpdatedBy Edm.String true 80 true

LastUpdatedOn Edm.String true

LinkWebURL Edm.String ture false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

PrimaryObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

OData Services
140 PUBLIC OData API Reference
 Max
Name Type Nullable Length Fixed length $Search Relevant

TypeCodeText Edm.String true

UUID Edm.Guid false

3.2.15.3 Phone Call Notes

Overview

The Phone Call Notes collection allows you to track and document your phone calls with the business partners.

Top Level Entity

Phone Call

Properties

Max
Name Type Nullable Length Fixed length $Search Relevant

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String ture 70 true

OData Services
OData API Reference PUBLIC 141
 Max
Name Type Nullable Length Fixed length $Search Relevant

PrimaryObjectID Edm.String true 70 true

Text Edm.String true false

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

3.2.15.4 Phone Call Participants

Overview

The Phone Call Participants collection allows to track and document your phone calls with your business partners.

Top Level Entity

Phone Call

Properties

Name Type Nullable Max Length Fixed length

Address Edm.String true 480 true

EMail Edm.String true 765 true

Name c4codata.EN­ true

CRYPTED_LONG_Nam
e

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

OData Services
142 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

PartyID Edm.String true 60 true

PartyUUID Edm.String true

Phone Edm.Strring true 350 true

RoleCode Edm.DateTIme true 10 false

RoleCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

PhoneCall PhoneCallParticipants PhoneCallN 1..*

3.2.16 Product Entity Type

The Product related collections allow you to read and maintain products, and categories and sales organization
they are assigned to.

OData Services
OData API Reference PUBLIC 143
3.2.16.1 Product

Overview

A Product is an article or a substance that is manufactured or refined for sale. It can be part of any object instance
such as an Opportunity or Lead etc. Hence, this entity allows you to create, view, and update the product in an
organizational master data

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/ProductCollection

Properties

Name Type Nullable Max Length Fixed length

ChangedOn Edm.DateTimeOffset false

CreatedBy Edm.String false 480 true

CreatedOn Edm.DateTimeOffset false

Description Edm.String true

LanguageCode Edm.String true 1 true

LanguageCodeText Edm.String true

ID Edm.String true 40 true

ObjectID Edm.String false 70 true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

UUID Edm.Guid false

UnitOfMeasureCode Edm.String true 3 true

OData Services
144 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

UnitOfMeasureCode­ Edm.String true

Text

Navigations

Name FromEntity ToEntity Cardinality

ProductAttachment Product ProductAttachment 1..*

ProductCategoryAssignment Product ProductCategoryAssignment 1..*

ProductChangedBy Product ProductChangedBy 1..*

ProductSales Product ProductSales 1..*

3.2.16.2 Product Attachment

Overview

The Product Attachment collection provides information about new or existing attached documents of a Product.

Top Level Entity

Product

Properties

Name Type Nullable Max Length Fixed length

Binary Edm.Binary false false

CategoryCode Edm.String false true

OData Services
OData API Reference PUBLIC 145
Name Type Nullable Max Length Fixed length

CategoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true

LastUpdatedBy Edm.String true 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

3.2.16.3 Product Category Assignment

Overview

The ProductCategoryAssignment collection provides a category that is associated to a product. This entity helps
you to assign a category to a product.

OData Services
146 PUBLIC OData API Reference
Properties

Name Type Nullable Max Length Fixed length

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

ProductCategoryDe­ c4codata.MEDIUM_De­ true

scription scription

ProductCategoryID Edm.String true 20 true

ProductCategoryUUID Edm.Guid true

Navigations

Name FromEntity ToEntity Cardinality

Product ProductCategoryAssignment Product 1..*

3.2.16.4 Product Category Hierarchy

Overview

The Product Category collection contains a tree structure where the Top level hierarchy has multiple sub
categories. A Product can be associated with any of these sub categories or the Top level Hierarchy ID.

Properties

Name Type Nullable Max Length Fixed length

InternalID Edm.String true 20 true

ObjectID Edm.String true 70 true

OData Services
OData API Reference PUBLIC 147
Name Type Nullable Max Length Fixed length

ParentInternalID Edm.String true 20 true

ProductAssignmentAl­ Edm.Boolean true

lowedIndicator

Navigations

Name FromEntity ToEntity Cardinality

ProductCategoryHierarchyDe­ ProductCategoryHierarchy ProductCategoryHierarchyDe­ 1..*

scription scription

3.2.16.5 Product Category Hierarchy Description

Overview

The Product Category Hierarchy Description collection provides a Product description of all category hierarchies.

Properties

Name Type Nullable Max Length Fixed length

Description Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

LanguageCode Edm.String true 1 true

LanguageCodeText Edm.String true

OData Services
148 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

ProductCategoryHierarchy ProductCategoryHierarchyDe­ ProductCategoryHierarchy 1..*

scription

3.2.16.6 Product ChangedBy

Overview

The Product Changed By collection provides information about the Business Partner, who recently changed the
Product. This is a read-only entity.

Properties

Name Type Nullable Max Length Fixed length

BusinessPartnerFor­ Edm.String true 480 true

mattedName

ObjectID Edm.String true 70 true

3.2.16.7 Product Sales

Overview

The Product Sales collection provides information about the Sales Organization from which the Product is to be
procured from. Here, we maintain data such as the Quantity and its Unit of Measure, the distribution channel etc.
as mentioned below. We can also track the procurement status.

OData Services
OData API Reference PUBLIC 149
Top Level Entity

Product

Properties

Name Type Nullable Max Length Fixed length

DistributionChannel­ Edm.String true 2 true

Code

DistributionChannelCo­ Edm.String true

deText

MinimumOrderQuantity c4codata.Quantity true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

SalesOrganisationID Edm.String true 20 true

SalesOrganisationUUID Edm.String true

SalesUoMCode Edm.String true 3 true

SalesUoMCodeText Edm.String true

StatusCode Edm.String true 2 true

StatusCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

Product ProductSales Product 1..*

ProductSalesOrganisation ProductSales ProductSalesOrganisation 1..*

OData Services
150 PUBLIC OData API Reference
3.2.16.8 Product Sales Organisation

Overview

The ProductSalesOrganisation collection provides the Sales Organization Information ID of their corresponding
Product

Top Level Entity

Product

Properties

Name Type Nullable Max Length Fixed length

ObjectID Edm.String true 70 true

3.2.17 Service Request Entity Type

The ServiceRequest related collections allow you to read and maintain information about ServiceRequest list of
open, completed and in process tickets.

OData Services
OData API Reference PUBLIC 151
3.2.17.1 Service Request

Overview

The ServiceRequest collection provides information about list of open, completed and in process tickets. Multiple
tasks can be performed on tickets such as creation, assignment of ticket, status change, adding notes, priority
change etc.

Properties

Name Type Description

ActivityCategoryName c4codata.MEDIUM_Name Indicates the type of re­

sponse action made on the
ticket

ActivityServiceIssueCategoryID Edm.String Indicates the activity level

service category assigned to
the ticket

ApprovalStatusCode Edm.String Indicates the approval status

of the ticket:

1- Not Started

2 - Approval Not Necessary

3- In Approval

4- Approved

5 - Rejected

6 - In Revision

7 - Withdrawn

ApprovalStatusCodeText Edm.String Stores the text for the above

mentioned codes

AssignedTo Edm.String Indicates to whom the ticket

is assigned.

AssignedToName c4codata.ENCRYPTED_LONG_Name Specify to whom you wish to

assign the ticket.

CauseCategoryName c4codata.MEDIUM_Name Indicates the cause of the is­

sue raised by the ticket

CauseServiceIssueCategoryID Edm.String Indicates the cause level

service category assigned to
the ticket

OData Services
152 PUBLIC OData API Reference
Name Type Description

ChangedBy Edm.String Indicates the user who has

made the changes.

CompletedOnDate Edm.DateTime Indicates the date on which

the ticket was addressed
completely

CompletionDueDate Edm.DateTime Indicates the due date for ad­

dressing the ticket

Contract Edm.String Specity the relevant contract

person for the ticket

ContractID Edm.String Indicates the relevant con­

tract ID for the ticket

CreatedBy Edm.String Indicates the user who has

created the ticket

CreationDate Edm.DateTime Indicates the date of creation

of the ticket

CreationDateTime Edm.DateTimeOffset Indicates the date and time of

the ticket

Customer Edm.String Indicates the customer who

owns the ticket

CustomerID Edm.String Indicates the customer ID for

the ticket

DataOriginTypeCode Edm.String Indicates the origin of the

data present in the ticket:

1 - Manual Data Entry

4 - Internet

5 - E-Mail

6 - Social Media

7 - Chat

8 - Telephony

DataOriginTypeCodeText Edm.String Stores the text for the above

mentioned codes

EscalationStatus Edm.String Indicates the escalation sta­

tus of the ticket

EscalationStatusText Edm.String Indicates the esclation de­

scription for the escalation
status ticket

ID Edm.String Indicates the formatted

name of the customer

IncidentCategoryName c4codata.MEDIUM_Name Indicates the incident raised

in the ticket

OData Services
OData API Reference PUBLIC 153
Name Type Description

IncidentServiceIssueCategoryID Edm.String Indicates the incident level

service category assigned to
the ticket

InitialResponseDate Edm.DateTime Indicates the date on which

the ticket was initially re­
sponded to

InitialReviewDueDate Edm.DateTime Indicates the due date for ini­

tial review of the ticket

InstallationPointID Edm.String Indicates the ID of the instal­

lation point of the product for
which the ticket was raised

InstalledBaseID Edm.String Indicates the ID of the base

where the product, for which
the ticket was raised, is
present.

ItemListServiceRequestExecutionLifeCycleStatusCode Edm.String Indicates the status of the

ticket:

1 - Open

2 - In Planning

3 - Ready

4 - Partially Ready

5 - Started

6 - Finished

7 - Not Relevant

ItemListServiceRequestExecutionLifeCycleStatusCo­ Edm.String Stores the text for the above

mentioned codes
deText

LastChangeDate Edm.DateTime Indicates the date on which

the latest changes were
made to the ticket

LastChangeDateTime Edm.DateTimeOffset Indicates the date and time

on which the latest changes
were made to the ticket

LastResponseOnDate Edm.DateTime Indicates the date on which

the last response was made
on the ticket

Name c4codata.EXTENDED_Name Indicates the subject of the

ticket

NextResponseDueDate Edm.DateTime Indicates the due date for the

next response on the ticket

OData Services
154 PUBLIC OData API Reference
Name Type Description

ObjectCategoryName servicerequest.MEDIUM_Name Indicates the object men­

tioned in the ticket

ObjectID Edm.String Indicates the unique hexa­

decimal ID for the ticket

ObjectServiceIssueCategoryID Edm.String Indicates the object level

service category assigned to
the ticket

ParentServiceRequest Edm.String Indicates the parent service

request for the ticket

Partner Edm.String Indicates the partner who has

raised the ticket on behalf of
the customer

PartnerID Edm.String Indicates the partner ID who

has raised the ticket on be­
half of the customer

ProcessingTypeCode Edm.String Indicates the type of process­

ing done on the ticket:

SRRE - Employee Support

Ticket

SRRQ - Service Request

ZCLM - Claim (Z)

ZHRQ - Employee Support

(Z)

ProcessingTypeCodeText Edm.String Stores the text for the above

mentioned codes

ProductCategoryDescription Edm.String Indicates the description of

the product category used in
the ticket

ProductID Edm.String Indicates the product ID used

in the ticket

ReferenceDate Edm.DateTime Indicates the date of refer­

ence for the ticket

ReportedForEmail Edm.String Indicates the E-Mail ID of the

party on behalf of which the
ticket was raised

ReportedForPartyID Edm.String Indicates the party ID on be­

half of which the ticket was
raised

ReporterEmail Edm.String Indicates the E-Mail ID of the

party who raised the ticket

ReporterPartyID Edm.String Indicates the Party ID who

raised the ticket

OData Services
OData API Reference PUBLIC 155
Name Type Description

RequestAssignmentStatusCode Edm.String Indicates the request assign­

ment status code for the
ticket

RequestAssignmentStatusCodeText Edm.String Indicates the request assign­

ment status code text for the
ticket

RequestedEnd Edm.String Indicates the requested end

for the ticket t

RequestedEndTimeZoneCode Edm.String Indicates the requested end

time zone for the ticket

RequestedStart Edm.String Indicates the requested start

date for the ticket

RequestedStartTimeZoneCode Edm.String Indicates the requested end

time zone for the ticket

RoleCode Edm.String Indicates the role code for

the ticket

RoleCodeText Edm.String Indicates the role code text

for the ticket

SalesTerritoryID Edm.String Indicates the territory ID for

sales

SerialID Edm.String Indicates the serial ID as­

signed to the ticket

ServiceAndSupportTeam Edm.String Indicates the service and

support team for the ticket

ServiceCategoryName c4codata.MEDIUM_Name Indicates the type of service

required for the Ticket

ServiceIssueCategoryID Edm.String Indicates the service level

service category assigned to
the ticket

ServiceLevelAgreement Edm.String Indicates the service level

agreement for the ticket

ServicePriorityCode Edm.String Indicates the priority of the

ticket:

1 - Immediate

2 - Urgent

3 - Normal

7 - Low

ServicePriorityCodeText Edm.String Stores the text for the above

mentioned codes

ServiceRequestClassificationCode Edm.String Stores the classification code

for the above mentioned co­
des

OData Services
156 PUBLIC OData API Reference
Name Type Description

ServiceRequestClassificationCodeText Edm.String Stores the classification code

text for the above mentioned
codes

ServiceRequestLifeCycleStatusCode Edm.String Indicates the user life cycle

status code for the ticket:

1 - Open

2 - In Process

4 - Customer Action

5 - Completed

6 - Closed

ServiceRequestLifeCycleStatusCodeText Edm.String Stores the text for the above

mentioned codes

ServiceRequestUserLifeCycleStatusCode Edm.String Stores the user lfie cycle sta­

tus code for the above men­
tioned codes

ServiceRequestUserLifeCycleStatusCodeText Edm.String Stores the user lfie cycle sta­

tus code text for the above
mentioned codes

ServiceTechnician Edm.String Indicates the service techni­

cian for the ticket

ServiceTechnicianTeam Edm.String Indicates the service techni­

cian team for the ticket

WarrantyDescription Edm.String Indicates the description of

the warranty applicable

WarrantyFrom Edm.DateTime Indicates the start date of the

warrznty

WarrantyTo Edm.DateTime Indicates the end date of the

warranty

Navigations

Name FromEntity ToEntity Cardinality

ServiceRequestAttachment­ ServiceRequest ServiceRequestAttachment­ 1 .. *

Folder Folder

ServiceRequestBusinessTran­ ServiceRequest ServiceRequestBusinessTran­ 0…*

sactionDocumentReference
sactionDocumentReference

ServiceRequestDescription ServiceRequest ServiceRequestDescription 1.. *

OData Services
OData API Reference PUBLIC 157
Name FromEntity ToEntity Cardinality

ServiceRequestItem ServiceRequest ServiceRequestItem 0.. *

ServiceRequestServiceRe­ ServiceRequest ServiceRequestServiceRe­ 0 .. *

questHistoricalVersion questHistoricalVersion

ServicePointLocationAddress ServiceRequest ServicePointLocationAddress 0…1

3.2.17.2 Service Point Location Address

Overview

The ServicePointLocationAddress Entity collection provides information about the service location where the
service has to be provided.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

AddressLine1 Edm.String true 240 true

AddressLine2 Edm.String true 240 true

AddressLine4 Edm.String true 240 true

AddressLine5 Edm.String true 240 true

City Edm.String true 240 true

Country Edm.String true 3 true

CountryText Edm.String true

County Edm.String true 240 true

OData Services
158 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $ Search Relevant

District Edm.String true 240 true

Email Edm.String true 765 true

Fax Edm.String true 350 true

HouseNumber Edm.String true 100 true

Language Edm.String true 1 true

LanguageText Edm.String true

Mobile Edm.String true 350 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Phone Edm.String true 350 true

POBox Edm.String true 100 true

POBoxPostalCode Edm.String true 100 true

POBoxPostalCode­ Edm.String true

Text

PostalCode Edm.String true 100 true

PostalCodeText Edm.String true

State Edm.String true 6 true

StateText Edm.String true

Street Edm.String true 360 true

WebSite Edm.String true 1280 true

3.2.17.3 Service Request Attachment Folder

Overview

The ServiceRequestAttachmentFolder Entity collection provides information about various attachments like
Documents, and Images etc. associated to a particular ticket.

These attachment types can be created and viewed using this collection.

OData Services
OData API Reference PUBLIC 159
Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

AddressLine1 Edm.Binary true 1 false

Binary Edm.String false true

CategoryCode Edm.String true 80

CategoryCodeText Edm.String true true

CreatedBy Edm.String true

CreatedOn Edm.DateTime true 80

DocumentLink Edm.String true

LastUpdatedBy Edm.String true true

LastUpdatedOn Edm.DateTime true

LinkWebURI Edm.String true false

MimeType Edm.String true false

Name Edm.String true false

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UUID Edm.Guid false

OData Services
160 PUBLIC OData API Reference
3.2.17.4 Service Request Business Transaction Document
Reference

Overview

The ServiceRequestBusinessTransactionDocumentReference collection provides information about follow up

documents of service request.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

ID Edm.String true 35

RoleCode Edm.String true 3

RoleCodeText Edm.String true

SocialMediaChan­ Edm.String true 3 true

nelCode

SocialMediaChan­ Edm.String true

nelCodeText

TypeCode Edm.String true 15

TypeCodeText Edm.String true

OData Services
OData API Reference PUBLIC 161
Navigations

Name FromEntity ToEntity Cardinality

ServiceRequestBusinessTran­ ServiceRequestBusinessTran­ ServiceRequest 1

sactionDocumentReference
sactionDocumentReference

3.2.17.5 ServiceRequestDescription

Overview

The ServiceRequestDescription collection provides information and allows you to view and add more information
related to the ticket. All details such as any email, interaction are mentioned here and used for further processing.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 true

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

OData Services
162 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $ Search Relevant

Text Edm.String true false

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UpdatedOn Edm.DateTime true

3.2.17.6 Service Request Item

Overview

The ServiceRequestItem collection provides information about the products mentioned in the tickets, which are
open, completed, and in process. Multiple items can be created and it can be updated.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Dsescription Edm.String true 40 true

ProductCategory­ Edm.String true 80 true

Descripiton

ProductID Edm.String true 60 true

ProductDescritp­ Edm.String true 40 true

tion

OData Services
OData API Reference PUBLIC 163
Navigations

Name FromEntity ToEntity Cardinality

ServiceRequestItem ServiceRequestItem ServiceRequest 1

ServiceRequestItemSchedule­ ServiceRequestItem ServiceRequestItemSchedule­ 0...*

Line Line

3.2.17.7 Service Request Item ScheduleLine

Overview

The ServiceRequestFirstRequestedItemScheduleLine collection provides details of quantity of scheduled items

mentioned in the service request.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true true

ParentObjectID Edm.String true 70 true true

Quantity c4codata.Quantity false false

OData Services
164 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

ServiceRequestItem ServiceRequestItemSchedule­ ServiceRequestItem 1

Line

ServiceRequest ServiceRequestItemSchedule­ ServiceRequest 1

Line

3.2.17.8 Service Request Service Request Historical Version

Overview

The ServiceRequestServiceRequestHistoricalVersion collection provides information and allows you to view and
information about Historical data related to the ticket. It provides information such as start and end time,
processor party, teams involved previously.

Top Level Entity

ServiceRequest

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

EndDateTime Edm.DateTime true 21 true

EscalationStatus­ Edm.String true 2 true

Code

MainIncidentServi­ Edm.String true 25 true

ceIssueCategory­
CatalogueID

MainIncidentServi­ Edm.String true 25 true

ceIssueCategoryID

ObjectID Edm.String true 70 true

OData Services
OData API Reference PUBLIC 165
Name Type Nullable Max Length Fixed length $ Search Relevant

ParentObjectID Edm.String true 70 true

ProcessorPar­ Edm.Guid true 36 true

tyUUID

SalesAndService­ Edm.Guid true 36 true

BusinessAreaServi­
ceOrganisatio­
nUUID

ServiceRequestLi­ Edm.String true 2 true

feCycleStatusCode

ServiceSupport­ Edm.Guid true 36 true

TeamPartyUUID

ServiceTermServi­ Edm.String true 25 true

ceIssueCategory­
CatalogueID

ServiceTermServi­ Edm.String true 25 true

ceIssueCategoryID

ServiceTermsServi­ Edm.String true 1 true

cePriorityCode

ServiceTermsServi­ Edm.String true 2 true

ceRequestUserLife­
CycleStatusCode

StartDateTime Edm.DateTimeOff- true 21 true

set

Navigations

Name FromEntity ToEntity Cardinality

ServiceRequest ServiceRequestServiceRe­ ServiceRequest 1

questHistoricalVersion

OData Services
166 PUBLIC OData API Reference
3.2.17.9 Service Issue Category Catalogue

Overview

The ServiceIssueCategoryCatalogue collection provides reference to the Catalogue which contains the Category
selection for the Service Request. It contains a hierarchical structure and is used to define various categories on
Service Request. These categories may change over a period of time and thus can have multiple versions but only
one active version is used for a particular day

Top Level Entity

ServiceIssueCategory

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true

EndDateTime Edm.DateTimeOff- true

set

StartDateTime Edm.DateTimeOff- true

set

VersionID Edm.String true 32 true

LifeCycleStatus­ Edm.String true 3 true

Code

LifeCycleStatusCo­ Edm.String true

deText

Navigations

Name FromEntity ToEntity Cardinality

ServiceIssueCategoryCatalo­ ServiceIssueCategoryCata­ ServiceIssueCategoryCatalo­ 0…*

logue gueCategory
gueCategory

OData Services
OData API Reference PUBLIC 167
Name FromEntity ToEntity Cardinality

ServiceIssueCategoryCatalo­ ServiceIssueCategoryCatalo­ ServiceIssueCategoryCatalo­

gueParentCategory gueCategory gueParentCategory

3.2.17.10 Service Issue Category Catalogue Category

Overview

The ServiceIssueCategoryCatalogueCategory collection provides category details of the Service Category

Catalogue

Top Level Entity

ServiceIssueCategoryCatalogue

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Name servicerequest.ME­ false

DIUM_Name

ServiceIssueCate­ Edm.String true 25 true

goryID

UUID Edm.Guid true

TypeCode Edm.String true 3 true

TypeCode Text Edm.String true

OData Services
168 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

ServiceIssueCategoryCata­ ServiceIssueCategoryCatalo­ ServiceIssueCategoryCata­ 1

gueCategory
logue logue

3.2.17.11 Service Issue Category Catalogue Parent Category

Overview

The ServiceIssueCategoryCatalogueParentCategory collection provides details of parent category in the

hierarchical structure of Service Issue Category Catalogue

Top Level Entity

ServiceIssueCategoryCatalogueCategory

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

Name servicerequest.ME­ false

DIUM_Name

ServiceIssueCate­ Edm.String true 25 true

goryID

TypeCode Edm.String true 3 true

TypeCode Text Edm.String true

OData Services
OData API Reference PUBLIC 169
Navigations

Name FromEntity ToEntity Cardinality

ServiceIssueCategoryCata­ ServiceIssueCategoryCatalo­ ServiceIssueCategoryCata­ 1

gueParentCategory logue
logue

3.2.18 Task Entity Type

The Task related collections allow you to read and maintain business relavant measures that need to be taken and
parties involved in these measures.

3.2.18.1 Task

Overview

The Task collection provides information about all business relevant measures that one or more employees of an
organization need to take care within a specified date

OData Services
170 PUBLIC OData API Reference
Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/TaskCollection

Properties

$Search Rele­
Name Type Nullable Max Length Fixed length vant

Account c4codata.EN­ true false

CRYPTED_LONG_N
ame

AccountID Edm.String true 60 true

AccountUUID Edm.Guid true

CatagoryCode Edm.String true 4 true

CatagoryCodeText Edm.String true

CompletionDate­ Edm.DateTimeOff- true

Time set

CompletionPercent Edm.Decimal true

DueDataTime c4codata.LOCAL­ true

NORMALISED_Da­
teTime

ID Edm.Guid true 35 true true

ObjectID Edm.String true 70 true

Owner c4codata.EN­ true

CRYPTED_LONG_N
ame

OwnerUUID Edm.Guid

PrimaryContact c4codata.EN­ true

CRYPTED_LONG_N
ame

PrimaryContactID Edm.String true 60

OData Services
OData API Reference PUBLIC 171
 $Search Rele­
Name Type Nullable Max Length Fixed length vant

PrimaryContac­ Edm.Guid true

tUUID

PriorityCode Edm.String true 1 true

PriorityCodeText Edm.String true

Processor c4codata.EN­ true

CRYPTED_LONG_N
ame

ProcessorID Edm.String true 60 true

ProcessorUUID Edm.Guid true

StartDateTime c4codata.LOCAL­ true false

NORMALISED_Da­
teTime

StatusCode Edm.String true 2 true true

StatusCodeText Edm.String true

Subject Edm.String true 765 true true

TypeCode Edm.String true 15 true

ReportedDateTime Edm.DateTimeOff- true

set

TypeCodeText Edm.String true

Navigations

Name FromEntity ToEntity Cardinality

TaskAttachment Task TaskAttachment 1 .. *

TaskInvolvedParties Task TaskInvolvedParties 1 .. *

TaskNotes Task TaskNotes 1 .. *

OData Services
172 PUBLIC OData API Reference
3.2.18.2 Task Attachment

Overview

The TaskAttachment collection provides information about existing attached documents in the Task.

Top Level Entity

Task

Properties

$Search Rele­
Name Type Nullable Max Length Fixed length vant

Binary Edm.Binary true false

CatagoryCode Edm.String false true

CatagoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true 80 false

LastUpdatedBy c4codata.EN­ true

CRYPTED_LONG_N
ame

LinkWebURL Edm.Guid false

MimeType c4codata.EN­ true false

CRYPTED_LONG_N
ame

Name Edm.String true false

ObjectID Edm.Guid true 70 true

ParentObjectID Edm.String true 70 true

OData Services
OData API Reference PUBLIC 173
 $Search Rele­
Name Type Nullable Max Length Fixed length vant

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

3.2.18.3 Task Involved Parties

Overview

The Task Involved Parties collection provides information about all the parties involved in a particular task.

Top Level Entity

Task

Properties

Name Type Nullable Max Length Fixed length $ Search Relevant

Address Edm.String true 480 true

EMail Edm.String true 765 true

Name c4codata.EN­ true

CRYPTED_LONG_N
ame

ObjectID Edm.String false 70 true

ParentObjectID Edm.String true 70 true true

PartyID Edm.String true 60 true

PartyUUID Edm.Guid true

Phone Edm.String true 350 true

OData Services
174 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length $ Search Relevant

RoleCategoryCode Edm.String true 3 true

RoleCategoryCode­ Edm.String true

Text

RoleCode Edm.String true 10 true

RoleCodeText Edm.String true

Navigations

Name FromRole ToRole Cardinality

Task TaskInvolvedParties Taskt 1 ..1

3.2.18.4 Task Notes

Overview

The Task Notes collection provides key information notes created during the task creation.

Top Level Entity

Task

Properties

$Search Rele­
Name Type Nullable Max Length Fixed length vant

AuthorName Edm.String true 40 true

OData Services
OData API Reference PUBLIC 175
 $Search Rele­
Name Type Nullable Max Length Fixed length vant

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

LanguageCode Edm.String true 2 false

LanguageCodeText Edm.String true

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.Guid true 70 true

ParentObjectID Edm.String true 70 true

Text Edm.String true false

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

UpdatedOn Edm.DateTime true

3.2.19 TimeEntry

The TimeEntry Entity Type has three entities namely the TimeEntry, TimeEntryItem and the TimeReport. These
entities are used in time recording.

3.2.19.1 Time Entry

The Time Entry collection is used to maintain time entry of employees. Time entry is an object where an employee
can record his time against his activities for a particular day.

OData Services
176 PUBLIC OData API Reference
Properties

Name Type Description Search Relevant

AutoTimeRecordingIndicator Edm.Boolean

BillingRelevanceIndicator Edm.Boolean Indicates whether the time en­

try is Billing Relevant or not.

BusinessTransactionDocu­ Edm.String
mentTypeCode

BusinessTransactionDocu­ Edm.String Indicates the date for which

mentTypeCodeText the time entry is recorded.

Date Edm.DateTime

Description c4codata.EXTENDED_Name Indicates the description for

the time entry.

Duration Edm.String Indicates the duration of the

work logged in the time entry.

EmployeeUUID Edm.Guid Indicates the UUID for the em­

ployee for which the time en­
try is created.

EndDateTime Edm.Time Indicates the End date and

time for the time entry.

HeaderReferenceUUID Edm.Guid Indicates the UUID for the

Service Ticket for which the
time entry is recorded.

ItemReferenceUUID Edm.Guid

LifeCycleStatusCode Edm.String Specifies the Status of the

time entry.

1. In Preparation
2. Approval Pending
3. Approved
4. Rejected
5. Released
6. In Approval

LifeCycleStatusCodeText Edm.String Indicates the description for

the status of the time entry.

ObjectID Edm.String Indicates the unique hexadeci­

mal id for time entry.

OData Services
OData API Reference PUBLIC 177
Name Type Description Search Relevant

StartDateTime Edm.Time Indicates the Start date and

time for the time entry.

TimeReportUUID Edm.Guid Indicates the UUID for the

time report corresponding to
this time entry.

TimeTypeCode Edm.String Indicates the Time Type Code:

1. Working Hours
2. Non-Working Hours

TimeTypeCodeText Edm.String Indicates the description for

the Time Type Code.

TimeZone Edm.String Indicates the time zone of the

time entry recorded.

TimeZoneText Edm.String Indicates the description of

the time zone for the time en­
try recorded.

Navigations

Name From Entity To Entity Cardinality

Employee TimeEntry Employee 0..1

ServiceRequest TimeEntry ServiceRequest 0..1

TimeEntryItem TimeEntry TimeEntryItem 0..*

TimeReport TimeEntry TimeReport 0..1

3.2.19.2 TimeEntryItem

The Time Entry Item collection is used to maintain time entry items related to the particular time entry. We can
have multiple time entry items for a time entry.

Properties

Name Type Nullable Creatable Updatable Filterable

ID Edm.String True True True True

ObjectID Edm.String True False False True

OData Services
178 PUBLIC OData API Reference
Name Type Nullable Creatable Updatable Filterable

ParentObjectID Edm.String True False Fasle True

ProductID Edm.String True True True True

ServiceItemUUID Edm.Guid True True True True

TimeItemDuration Edm.String True True True True

TimeItemEndDate Edm.DateTime True True True True

TimeItemEndTime Edm.Time True True True True

TimeItemStartDate Edm.DateTime True True True True

TimeItemStartTime Edm.Time True True True True

TimeItemUUID Edm.Guid True True True True

TimeZoneCode Edm.String True True True True

TimeZoneCodeText Edm.String True False False True

UUID Edm.Guid True True True True

Navigations

Name From Entity To Entity Cardinality

TimeEntry TimeEntryItem TimeEntry 1

3.2.19.3 TimeReport

The Time Report collection is used to maintain time reports of employees. You can use it to group time entries for
an employee for a time period.

Properties

Name Type Description $ Search Relevant

Description c4codata.EXTENDED_Name

EmployeeUUID Edm.Guid Indicates the UUID for the em­

ployee for which the time re­
port is created.

EndDate Edm.DateTime Indicates the End Date of the

time report.

OData Services
OData API Reference PUBLIC 179
Name Type Description $ Search Relevant

ObjectId Edm.String Indicates the unique hexadeci­

mal id for time report.

RejectionReason c4codata.Text Indicates the reason for rejec­

tion of the time report.

ReportName c4codata.EXTENDED_Name Indicates the name and lan­

guage code for the time re­
port.

StartDate Edm.DateTime Indicates the End Date of the

time report.

Status Edm.String Indicates the status of the

Time Report.

• In Preparation
• Approval Pending
• Approved
• Rejected
• In Approval

StatusText Edm.String Indicates the description for

the status of the time report.

TotalDuration Edm.String Indicates the total duration of

the time report.

Navigations

Name From Entity To Entity Cardinality

Employee TimeReport Employee 0..1

TimeEntry TimeReport TimeEntry 0..*

3.2.20 User Entity Type

The User Entity Type collection is a Single Entity Type. The EntityGroup description are not required.

OData Services
180 PUBLIC OData API Reference
3.2.20.1 User

Overview

The User collection provides information about all the user details.

Request Elements

URL

https://<CloudTenant>/sap/c4c/odata/v1/c4codata/UserCollection

Properties

Name Type Nullable Max Length Fixed length

ChangedBy Edm.String true 480 true

ChangedByUUID Edm.Guid true

ChangedOn Edm.DateTimeOffset true

CreatedBy Edm.String true 480 true

CreatedByUUID Edm.Guid true

CreatedOn Edm.DateTimeOffset true

DateFormatCode Edm.String true 2 true

OData Services
OData API Reference PUBLIC 181
Name Type Nullable Max Length Fixed length

DateFormatCodeText Edm.String true

DecimalFormatCode Edm.String true 2 true

DecimalFormatCode­ Edm.String true

Text

EmployeeID Edm.String true 10 true

EmployeeUUID Edm.Guid true

InactiveIndicator Edm.Boolean true

LogonLanguageCode Edm.String true 1 true

LogonLanguageCode­ Edm.String true

Text

ObjectID Edm.String true 70 true

PasswordInactiveIndi­ Edm.Boolean true

cator

PasswordLockedIndica­ Edm.Boolean true

tor

PasswordPolicyCode Edm.String true 40 true

PasswordPolicyCode­ Edm.String true

Text

StatusCode Edm.String true 2 true

StatusCodeTrue Edm.String true

TimeFormatCode Edm.String true 2 true

TImeFormatCodeText Edm.String true

TimeZoneCode Edm.String true 10

TimeZoneCodeText Edm.String

TitleCode Edm.String true 4 true

TitleCodeText Edm.String true

UUID Edm.Guid true

UserID Edm.String true 40 true

OData Services
182 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

UserAccountID Edm.String true 255 true

UserAccountTypeCode Edm.String true 1 true

UserAccountTypeCode­ Edm.String true

Text

UserID Edm.String true 40

true

Username Edm.String true 480 true

3.2.21 Visit Entity Type

The Vist related collections allow you to read and maintain customer site visits, parties involved in the visits and
related business transaction reference documents.

OData Services
OData API Reference PUBLIC 183
3.2.21.1 Visit

Overview

The Visit Collection provides information about customer site visits.

Properties

Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

AllDayEvent Edm.Boolean true

AccountUUID Edm.Guid true

DistributionChannel Edm.String true 2 true

DistributionChannel­ Edm.String true

Text

Division Edm.String false 2 true

DivisionText Edm.String true

EndDateTime c4codata.LOCAL­ false

NORMALISED_Date­
Time

GroupCode Edm.String true 4

GroupCodeText Edm.String true

Location Edm.String true 480

ID Edm.String true 35

ObjectID Edm.String true 70 true

OrganizerUUID Edm.Guid true

OwnerUUID Edm.Guid true

PrimaryContactUUID Edm.Guid true

OData Services
184 PUBLIC OData API Reference
 Max
Lengt
Name Type Nullable h Fixed length $Search Relevant

Route Edm.Guid true

SalesOrganisation Edm.String true 20

StartDateTime c4codata.LOCAL­ true

NORMALISED_Date­
Time

Status Edm.String true 2 true

StatusText Edm.String true

Subject Edm.String true 765 true

SalesTerritory Edm.String true 6 true

Tour Edm.Guid true

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true 15

AdditionalLocation­ Edm String true 765 true

Name

GroupwareItemID Edm String true 765 true

ReportedDateTime Edm.DateTimeOffset true

 Note

The properties such as GroupCode and TypeCode have default values that cannot change.

Navigations

Name FromEntity ToEntity Cardinality

Visti Attachment Visit VisitAttachment 1 .. *

OData Services
OData API Reference PUBLIC 185
3.2.21.2 Visit Attachment

Overview

The Visit Attachment collection provides information about attached documents in Visits.

Top Level Entity

Visit

Properties

Name Type Nullable Max Length Fixed length

Binary Edm.Binary true false

CategoryCode Edm.String false

CategoryCodeText Edm.String true

CreatedBy Edm.String true 80 true

CreatedOn Edm.DateTime true

DocumentLink Edm.String true false

LastUpdatedBy Edm.String true 80 true

LastUpdatedOn Edm.DateTime true

LinkWebURL Edm.String true false

MimeType Edm.String true false

Name Edm.String true 70 false

ObjectID Edm.String true 70 true

TypeCode Edm.String true 5 true

TypeCodeText Edm.String true

OData Services
186 PUBLIC OData API Reference
Name Type Nullable Max Length Fixed length

UUID Edm.Guid false

3.2.21.3 Visit Party

Overview

The Visit Party collection provides information of all the customers who visits the site.

Top Level Entity

Visit

Properties

Name Type Nullable Max Length Fixed length

Email Edm.Binary true 254 true

FormattedPhoneNum­ Edm.Guid true 40 true

ber

MainIndicator Edm.Boolean true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

PartyID Edm.String true 60 true

PartyName Edm.String true 255 true

PartyRoleCode Edm.String true 10 true

PartyRoleCodeText Edm.String true

PartyUUID Edm.Guid true

OData Services
OData API Reference PUBLIC 187
Navigations

Name FromEntity ToEntity Cardinality

Visit VisitParty Visit 1..1

3.2.21.4 Visit Reference

Overview

The Visit Reference collection provides information about the preceding and succeeding reference documents.

Top Level Entity

Visit

Properties

Name Type Nullable Max Length Fixed length

ID Edm.Binary true 35 true

ItemUUID Edm.Guid true

ObjectID Edm.String true 70

ParentObjectID Edm.String true true

ReferenceRoleCode Edm.String true 3

ReferenceRoleCode­ Edm.String true false

Text

TypeCode Edm.String true 15 true

TypeCodeText Edm.String true

OData Services
188 PUBLIC OData API Reference
Navigations

Name FromEntity ToEntity Cardinality

Visit VisitReference Visit 1 .. 1

3.2.21.5 Visit Text

Overview

The VisitText Collection provides information about notes entered during site visit.

Top Level Entity

Visit

Properties

Name Type Nullable Max Length Fixed length

AuthorName Edm.String true 40 true

AuthorUUID Edm.Guid true

CreatedBy Edm.String true 80 true

CreatedOn Edm.Guid true

LanguageCode Edm.String true 2

LanguageCodeText Edm.String false

LastUpdatedBy Edm.String true 80 true

ObjectID Edm.String true 70 true

ParentObjectID Edm.String true 70 true

OData Services
OData API Reference PUBLIC 189
Name Type Nullable Max Length Fixed length

Text Edm.String true false

TypeCode Edm.Guid true 5 true

TypeCodeText Edm.String true

UpdatedOn Edm.String true

3.2.22 Marketing Attributes Entity Type

Marketing attributes are associated to master data objects like accounts and contacts. They allow users to define
and maintain name value pairs for master data. They are similar to marketing attributes in SAP CRM.

There are two parts to maintaining marketing attributes:

1. Create and maintain definitions.

This involves creating marketing attributes and marketing attribute sets and assigning the marketing attributes
to marketing attribute sets. It also involves MarketingAttribute and MarketingAttributeSet ODATA services.
2. 2. Assignment of marketing attribute sets to master data objects and maintaining attribute values.
This is done using the marketing attribute assignment ODATA service.

3.2.22.1 Marketing Attribute (BusinessAttribute)

Attribute definition

Properties

Search Rele­
Name Type Nullable Max Length Fixed length vant

Marketing Attribute Edm.String true 30 true

ID (ID )

Number of Charac­ Edm.Int16 true true

ters (Character­
NumberValue)

Number of Decimal Edm.Int16 true

Places (Decimal­
NumberValue)

Status (LifeCycleS­ Edm.String false 1 true

tatusCode)

OData Services
190 PUBLIC OData API Reference
 Search Rele­
Name Type Nullable Max Length Fixed length vant

Unit of Measure Edm.String true 5 true

(MeasureUnitCode)

Format (Represen­ Edm.String true 4 true

tationFormatCode)

Name Edm.String true 255 true

languageCode Edm.String true 1 true

Mandatory Indicator Edm.Boolean true

Multivalue Indicator Edm.Boolean true

Negative Allowed In­ Edm.Boolean true

dicator

Case Sensitive Indi­ Edm.Boolean true

cator

Interval Allowed In­ Edm.Boolean true

dicator

Navigations

Name FromEntity ToEntity Cardinality

BusinessAttributeCharacteris­ Marketing Attribute BusinessAttributeCharacteris­ 0.. *

tic tic

BusinessAttributeDescription Account BusinessAttributeDescription 1 .. *

BusinessAttributeValueList Account BusinessAttributeValueList 0.. *

3.2.22.2 Marketing Attribute Description

(BusinessAttributeDescription)

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Name Edm.String true 255 true

OData Services
OData API Reference PUBLIC 191
 Max
Lengt
Name Type Nullable h Fixed length Search Relevant

languageCode Edm.String true 1 true

3.2.22.3 Marketing Attribute Value List

(BusinessAttributeValueList)

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

ID Edm.String true 30 true

Name Edm.String true 255 true

languageCode Edm.String true 1 true

3.2.22.4 Marketing Attribute Value List Description

(BusinessAttributeValueListDescription)

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Name Edm.String true 255 true

languageCode Edm.String true 1 true

OData Services
192 PUBLIC OData API Reference
3.2.22.5 Marketing Attribute Set (BusinessAttributeSet)

Group attributes into attribute sets

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Marketing Attribute Edm.String true 18 true

Set ID (BusinessAttri­
buteSetID)

Object Type Code Edm.String true 15 true

(ObjectTypeCode)

Organization Relevant Edm.Boolean true

(OrgananizationRele­
vanceIndicator)

Person Relevant (Per­ Edm.Boolean true

sonRelevanceIndica­
tor)

Status (LifeCycleSta­ Edm.String false 1 true

tusCode)

Name Edm.String true 40 true

languageCode Edm.String true 1 true

3.2.22.6 Marketing Attribute Set Description

(BusinessAttributeSetDescription)

To be used if attribute set descriptions exist in more than one language

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Name Edm.String true 40 true

OData Services
OData API Reference PUBLIC 193
 Max
Lengt
Name Type Nullable h Fixed length Search Relevant

languageCode Edm.String true 1 true

3.2.22.7 Marketing Attribute Set Attribute Assignment

(BusinessAttributeSetAttributeAssignment)

Assignment of marketing attributes to marketing attribute sets

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Marketing Attribute Edm.String true 30 true

ID (ID )

3.2.22.8 Marketing Attribute Assignment

(BusinessAttributeAssignment)

Assignment of marketing attributes to master data objects such as accounts or contacts.

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Object Type Code Edm.String true 15 true

(ObjectTypeCode)

Business Partner ID Edm.String true 18 true

Business Partner Ex­ Edm.String true 100 true true

ternal Key

OData Services
194 PUBLIC OData API Reference
  Note

Object Type Code has been removed in the 1711 release and the solution adds the required default value for this
property.

3.2.22.9 Marketing Attribute Assignment Item

(BusinessAttributeAssignmentItem)

Properties

Max
Lengt
Name Type Nullable h Fixed length Search Relevant

Business Attribute Edm.String true 18 true

Set ID

Business Attribute ID Edm.String true 30 true

Attribute Value Edm.String true 255 true

Business Partner ID Edm.String false 10 true true

3.2.23 HTTP Status Codes

HTTP SUCCESS CODE DESCRIPTION

200 OK The requested resource retrieval is successful, and a full pay­

load of the requested resource is returned.

HTTP ERROR CODES DESCRIPTION

400 Bad Request The server could not understand the request due to malformed
syntax.

403 Forbidden Access to the resource you are trying to connect to is forbid­
den. This may be due to either a user authentication failure or
to the user having insufficient privileges to perform the action.

404 Not Found The server cannot find the specified resource. This is typically
due to an unrecognized resource ID (such as userId, groupId,
or contentId).

405 Method Not Allowed The method specified in the Request Line is not allowed for the
resource identified by the Request URI.

OData Services
OData API Reference PUBLIC 195
HTTP SUCCESS CODE DESCRIPTION

409 Conflict There is an internal access conflict to the specified resource.

429 Too Many Requests The user has sent too many requests in a given period of time.
This error message is typically encountered if API rate limits,
set to protect against DoS attacks and to preserve server re­
sponsiveness, have been exceeded. See Rate Limits to view the
established limits.

500 Internal Server Error The server encountered an unexpected condition, which pre­
vented it from fulfilling the request.

501 Not Implemented The server does not support the functionality required to fulfill
the request.

3.2.24 Service Assignment Entity Type

Overview

The ServiceAssignment OData service enables the external application or user to perform the following actions:

1. Query all the Assignments.

2. Read Assignments by Assignment UUID.
3. Change the value of Status.

Properties

Name Type Description Search Relevant

ID Edm.String Indicates Assignment ID Yes

AssignmentUUID Edm.Guid Indicates UUID of the Assign­ Yes

ment

BusinessActivityUUID Edm.Guid Indicates the business activity

UUID of the assignment

CreatedBy Edm.String Indicates the user who has

created the assignment

CreationDateTime Edm.DateTimeOffset Indicates the date of creation

of the assignment

OData Services
196 PUBLIC OData API Reference
Name Type Description Search Relevant

LastChangedBy Edm.String Indicates the user who has

made the changes

Customer Edm.String Indicates the customer party Yes

for the assignment

CustomerID Edm.String Indicates the customer ID for Yes

the assignment

CustomerTypeCode Edm.String Indicates the customer role

type code for the assignment

DivisionCode Edm.String Indicates the Division code for

the assignment

StartDateTime Edm.DateTimeOffset Indicates the scheduled start Yes

date time for the assignment

StartDateTimeZoneCode Edm.String Indicates the scheduled start Yes

date time timezone code for
the assignment

EndDateTime Edm.DateTimeOffset Indicates the scheduled end Yes

date time for the assignment

EndDateTimeZoneCode Edm.String Indicates the scheduled end Yes

date time timezone code for
the assignment

Fixed Edm.String Indicates the fixed state of the

assignment:

1. Fixed Time
2. Fixed Time & Technician

Released Edm.String Indicates the released state of Yes

the assignment::

1. Released
<space> - Not Released

FullDayIndicator Edm.Boolean Indicates all day indicator:

X – True

<space> - False

OData Services
OData API Reference PUBLIC 197
Name Type Description Search Relevant

LifeCycleStatusCode Edm.String Indicates the status of the as­

signment:

1. Open
2. In Process
3. Completed
4. Canceled

OrganizerID Edm.String Indicates the organizer ID for

the assignment

OrganizerName Edm.String Indicates the organizer name

for the assignment

OrganizerTypeCode Edm.String Indicates the organizer party

type code for the assignment

PrimaryContact Edm.String Indicates the contact for the

assignment

PrimaryContactID Edm.String Indicates the contact party ID

for the assignment

PrimaryContactTypeCode Edm.String Indicates the contact party

type code for the assignment

Priority Edm.String Indicates the priority of the as­ Yes

signment:

1. Immediate
2. Urgent
3. Normal
4. Low

ProcessingTypeCode Edm.String Indicates the type of process­

ing done on the activity:

AACT – Assignment Activity

ServiceTechnician Edm.String Indicates the service techni­

cian for the assignment

ServiceTechnicianID Edm.String Indicates the service techni­

cian ID for the assignment

ServiceTechnicianTypeCode Edm.String Indicates the service techni­

cian party type code for the
assignment

OData Services
198 PUBLIC OData API Reference
Name Type Description Search Relevant

Status Edm.String Indicates the external status Yes

of the assignment

Subject Edm.String Indicates the subject of the as­ Yes

signment

TypeCode Edm.String Indicates the type code for the

assignment

2215 – Assignment Activity

ReferenceDocumentID Edm.String Indicates Document ID of the

reference document for the
assignment

ReferenceDocumentType­ Edm.String Indicates the Document type

Code code of the reference docu­
ment for the assignment

ReferenceDocumentUUID Edm.Guid Indicates the document UUID

of the reference document for
the assignment

ReferenceDocumentItemID Edm.String Indicates the item id of the ref­

erence document for the as­
signment

ReferenceDocumentItemTy­ Edm.String Indicates the item type code

peCode of the reference document for
the assignment

ReferenceDocumentItemUUID Edm.Guid Indicates the item UUID of the

reference document for the
assignment

Navigation

Name From Entity To Entity

ServiceAssignmentBusinessTransaction­ ServiceAssignment ServiceAssignmentBusinessTransaction­

DocReference DocReference

ServiceAssignmentNotes ServiceAssignment ServiceAssignmentNotes

OData Services
OData API Reference PUBLIC 199
3.2.24.1 Business Context and Use

The Service Assignment OData service enables you to connect external applications to your SAP Cloud for
Customer system and to read and query assignment data within your system.

EntityType Name = ServiceAssignment

Access our solution tenant using this example:

https://<C4C-tenant>/sap/c4c/odata/v1/c4codata/$metadata

Assignment OData Service enables the external application or user to perform the following action:

1. Query all the Assignments.

2. Read Assignments by Assignment UUID.
3. Change the value of Status.

3.2.24.2 Service Assignment Notes

This topic provides you with property values for the ServiceAssignmentNotes object.

Overview

ServiceAssignmentNotes provides information about the assignment. The text can be viewed, created, and
updated.

Properties

Properties of ServiceAssignmentNotes

Name Type Description

ParentObjectID Edm.String Indicates the ObjectID of the parent

which is the Assignment ObjectID

ObjectID Edm.String Indicates the notes’ UUID

TypeCode Edm.String Indicates the type code of the notes. The

type code of the Assignment notes is
10002

LanguageCode Edm.String Indicates the language code in which the

note has been added

OData Services
200 PUBLIC OData API Reference
Name Type Description

CreatedOn Edm.DateTime Indicates the time (and date) of the crea­

tion of the note

UpdatedOn Edm.DateTime Indicates the time (and date) at which

the note was last updated

CreatedBy Edm.String Indicates the User ID of the creator of the

note

LastUpdatedBy Edm.String Indicates the User ID of the last updater

of the note

AuthorName Edm.String

AuthorUUID Edm.Guid

3.2.25 API Strategy

We have updated our API strategy based on feedback received from customers.

Here is a summary of what this update means to you:

1. The following APIs are deprecated (as of the release August 2018) and will be obsolete as of the release
February 2020.:
• Standard synchronous inbound SOAP web services (A2X)
• SAP Cloud for Customer OData API v1

 Note

Obsolete APIs have the following behavior:

• They continue to work and are supported in existing implementations.
• They are not enhanced beyond bug fixes.
• They are not available for any new project to any customer.

2. The following APIs continue to be supported:

• Standard asynchronous inbound SOAP web services (A2A)
• Custom SOAP and Custom OData APIs
3. We recommend the following to all customers:
• Use SAP Cloud for Customer OData API v2 in your new implementations.
• Consider adapting SAP Cloud for Customer OData API v2 in any existing implementations that are based
on deprecated (and soon to be obsolete) APIs.

OData Services
OData API Reference PUBLIC 201
4 OData Service Explorer

This document provides an overview of the OData Editor and how you can use this editor to create OData services.
The OData Service Explorer view in the Administrator work center allows you, as an end user to create, edit, and
manage your OData services.

This view also lists the services that are created by you and the standard OData services offered by SAP. To view the
services created by you, select Custom OData Services from Show.

To view SAP OData Services, select SAP OData Services from Show.

In the Custom OData Services view, you can also download an OData service, by selecting a service and clicking
Download. Additionally you can download services in patches for testing by clicking Patch Download. This
functionality can be used if a patch solution exists in the system. The following table explains the criteria for
Download and Patch Download

Download Patch Download

Only if an original solution exists in the source system, down­ The patch solution can be used only if it exists in the source
load the service using theDownload button. system, for all the original solution business objects and fields
of an OData service.

During a download, the fields of the patch solution are replaced During a Patch Download, only the patch solution fields are
with fields of the original solution. downloaded. If there are fields from the original solution, they
are renamed to point to the patch solution.

For a successful upload, the target system should have the

patch solution.

4.1 Creating an OData Service

1. 1.In the SAP Cloud for Customer system, navigate to the Administrator work center, OData Service Explorer
view and select Custom OData Services from Show.

 Note

The SAP OData Services are default services that are provided by SAP and can only be viewed but not
edited. You can only edit Custom OData Services.

2. Select Data Workbench.

 Note

If this option is selected, the External Keys for the various entities for the service is enabled.

OData Services
202 PUBLIC OData Service Explorer
3. Click New and enter the OData Service Name in the Quick Create dialog box.
4. Click Save and Close to save the service or Save and Open to complete the service or Save and New to save this
service and create a new service. The OData service is set to Inactive after the service has been created.

 Note

When you create custom OData services, it is important to ensure that necessary authorizations are enabled
for the services. For more information, see Authorization [page 6].

4.1.1 Adding an Entity

Add an entity to a custom OData service.

1. From the OData view, select the OData service that you created and click Edit.
2. Select the Include Code Descriptions and select the checkbox, if you want to add the description of the code list
to your OData service. Enter the Work Center View for users with this work center view to see the OData
service.

 Note

The Include Code Descriptions setting applies to the entire OData Service. The Work Center View selection
applies only to this entity.

3. Click Select Business Object and enter the BO Name and BO Node Name . Click OK.

OData Services
OData Service Explorer PUBLIC 203
  Note

Standard business objects do not include nodes to create new entity types. However, field extensions are
available.

4. Select the relevant node for the entity from the Entity Types tab.

5. Select the relevant elements that are listed under the node.

 Note

The selected nodes elements are automatically populated under the OData Service structure. The entity
has a default property called ObjectID, which is the node ID of the corresponding business object.
Additionally, you can delete an entity type by selecting it and clicking Remove.

The following table explains some of the key node elements:

Node Element Description

Create Associated Entity A create associated entity that cannot be merged with any
other entity and is shown as a separate entity below the host
entity.

OData Services
204 PUBLIC OData Service Explorer
 Node Element Description

Merge Association A merge association entity can be merged with the active
entity. However merging entities is optional. If you do not
want to merge the entity, the system automatically creates
an entry below the host entity.

Dependent Object Association A dependent object association creates a new entity that
corresponds to the respective dependent object. The prop­
erties under this object cannot be edited. For example, Text
Collection and Attachment Folder .

If you create a new entity using an association, the navigation between the entity and element is added
automatically to both, it is bidirectional. If the association is between cross business objects, the navigation is
not bidirectional.
If you have selected Data Workbench, while creating a service, you can see two additional properties
ExternalKey and ParentExternalKey added to the entity structure.

If you create an entity by clicking the Select Business Object, the navigations are created automatically
between existing entities and the newly created entity.

OData Services
OData Service Explorer PUBLIC 205
6. Enter the following information under the Properties and Navigation Properties respectively:

UI Element Description

Delete Selecting this option would delete the selected entity type.

Name Enter the name of the entity type. This field can be edited
and a new name can be given.

Work Center View Enter the work center or view to which the end user should
have authorization, in order to view the data.

Title Property (Entity) The title can be mapped to the property of an entity that can
be mapped to elements and attributes of an entry or to cus­
tom elements of an entry in the feed.

Entity Set Name of the entity set entered in the OData service.

Entity Set Name of entity sets are relevant for fields of type Code. It in­
cludes code and description that references the entity type
Codelists

Null Select this option if you want the property to have a null
value.

Name Enter the name of the property. One entity type cannot have
two properties with same name.

Maximum Length Shows the maximum length of the property value.

Scale Enter the number of digits to the right of the decimal place
for the property value.

OData Services
206 PUBLIC OData Service Explorer
 UI Element Description

Default Value Enter the default value of the property. In the case of READ,
only those records that have this default value are returned.
In the case of WRITE , if no value is provided, then this de­
fault value is used.

Type Shows the type of the property. For example: String,

Guid, Boolean, and DateTime.

 Note
ComplexTypes are no longer supported for a new serv­
ice.

Path Shows the business object path for the property.

Title (Property) Select this option to specify the title property in the entity
type.

Enable Search Include the selected property in the search results. This op­
tion is only for $Search.

External Key Scheme Code Select a scheme code for the ExternalKey of the entity. The
list appears based on scoping.

7. Select Add Row from the Function Imports tab and enter the following details. However this step is optional. If
you want to call a BO Action enter the following:

1. Function Import Type - you can choose either Action or Query

2. Entity Name
3. HTTP Method
4. BO Action

 Note

Depending on the selected entity, the Parameters are automatically populated

8. Click Save and Activate.

OData Services
OData Service Explorer PUBLIC 207
4.1.2 Result

Once the service is saved successfully, the status of the OData service changes to Active and the Service URL is
generated. This contains the metadata information of the OData service.

For example, https://<customer tenant ID>/sap/c4c/odata/cust/v1/customodata/$metadata

4.2 Testing an OData Service

Use the OData Console to test a custom service.

The OData Console is available on click of the test button in OData Service Explorer. It lists all the SAP delivered and
custom services available in the respective SAP Cloud for Customer tenant.

Actors / Users

Actors / Users:

• Key Users: Key users are the system administrators who are responsible for managing OData Services.
• Business Users: Business users are the users with assigned roles and perform tasks on certain defined
components.

Key Features

ODataConsole has two key features as follows:

1. Exploring OData Services: This feature lets a user see all the entities that are available in the service and also
presents the properties of the entities in an intuitive way.
2. Testing OData Services: This feature simplifies the process of testing the OData service, wherein the user can
perform HTTP operations like Get, Post without getting into the finer details of syntax or authentication.

4.2.1 Exploring OData Services

An OData service is composed of a number of entity sets (collections), their properties, and associations
(navigation). An association describes the relationship between two entity sets. The user can select a service from
the selection help for the field Service. The list contains all the SAP delivered and custom services available in the
respective SAP Cloud for Customer tenant

When you select an entity set from the list, its properties and associations (if any) are listed under the Entity Details
tab and the Navigation Properties tab respectively.

OData Services
208 PUBLIC OData Service Explorer
The users can see the attributes of the property like type, label etc. An Expand Sign “>” is visible in front of the
Complex Type properties. The composition or sub-properties of the complex type property can be viewed by
clicking the expand icon.

The navigation properties section display all the direct associations of the entity.

4.2.2 Testing OData Services

You can test the OData services through HTTP requests, for retrieving, adding and updating data for the selected
entity set. You need to select the Entity of a service and then click on the Test tab to begin testing.

OData Services
OData Service Explorer PUBLIC 209
The test tab contains the Request and Response sections and these sections can be expanded and collapsed

through expand and collapse buttons on the right.

OData Console supports the following HTTP methods:

1. Get
2. Post
3. Patch
4. Put
5. Delete

The HTTP methods can be selected from the method drop down in the request section. Steps to Execute a Get
Request:

1. Select a Method from the selection help, under the Request section.
2. In the field next to the dropdown, the URL referencing the selected OData service collection is automatically
populated. You can further customize the request with the OData system query options, such as $filter,
$search, and so on by editing the URL.
3. There are three formats in which the user can provide the body or the payload :
1. Form: This tab presents the user with the properties of the entity, the user can fill the values of the
properties in the text boxes in front of the labels.
2. XML: This tab lets the user enter the payload in XML data format.
3. JSON: This tab lets the user enter the payload in JSON format. In the Form tab, enter values for Object ID
according to the properties of the collection and press execute.

You can add headers to the request using the headers tab in the request section. The application fetches an X-
CSRF token automatically when executing OData requests, and it is not necessary to provide this token manually.
The XML and JSON format are ideal for the key users who have created their payloads already or have got them
from some other application. The form format is very useful for business users who just want to casually test and
explore OData services.

OData Services
210 PUBLIC OData Service Explorer
The Form tab in the Request section also supports maintaining Complex Types. As soon as the user clicks in a text
box corresponding to a complex type property, a dialog screen is displayed with all the sub properties for the
complex type property . When you click on OK button, the values that you enter are saved onto the complex type
property .For example: . AccountName Property in Opportunity entity.

Also the Form tab provides the Code List help for the “Code” type properties that can have a set of defined values.
For example: .: Approval Status Code in Opportunity Entity.

OData Services
OData Service Explorer PUBLIC 211
The outcome of the HTTP requests will be displayed in the Request section. The Response can be seen in three
formats as well:

• Data: This presents the user with an excel view of the data. The values of Complex type properties is displayed
in curly braces with a comma. For example: . {USD,200.000000}
• XML: This tab can be used to see the response body in XML format.
• JSON: This tab can used to view the Response in JSON format.

The XML and JSON format and ideal for the key user as they can directly copy and use these payloads in other
applications. The Data format is ideal for they key users as it is very readable for lesser data and can be made sense
of very quickly. The Response sections also gives an option to download data in CSV format which was retrieved as
response from executing a Get Request. Also the user can see the response headers from the headers tab in
Response section.

OData Services
212 PUBLIC OData Service Explorer
As explained above , Other HTTP requests can be executed similarly by providing all the necessary details.

 Note

You will find the description of various HTTP methods in the Appendix.

4.2.3 Favorites

To reuse payloads, the payload for a particular request can be saved as a favorite template. In order to do so, you
need to provide a name and a description for the template to be saved. Saved favorites can later be loaded by
selecting under the Favorites tab.

You can easily create favorites by clicking on the Save as Favorite (adjacent to Execute button) in the Test tab. When
you click tthe button, you are prompted to provide the name and description of the favorite; Click on OK to confirm.

OData Services
OData Service Explorer PUBLIC 213
You can also delete the favorites with the help of the Delete Selected and Delete All buttons. The Delete selected
deletes all the selected rows and the Delete All clears all the favorites for the logged in user.

4.2.4 History

The last one hundred unique requests are stored in the history so that they can be accessed and executed again
later. The history entries are accessible under the History tab.

OData Services
214 PUBLIC OData Service Explorer
You can also delete the history with the help of the Delete Selected and Delete All buttons. The Delete Selected
deletes all the selected rows and the Delete All clears all the history rows for the logged in user.

4.2.5 Appendix

A table of Different Http Methods and their description:

Method Description

GET The GET method is used to retrieve using a given URI. Requests
using GET should only retrieve data and should have no other
effect on the data.

POST A POST request is used to create records for entities.

PUT A PUT request replaces all the current representations of the

target resource with the uploaded content.

DELETE A DELETE request removes all the current representations of

the target resource given by URI.

PATCH A PATCH request replaces only the provided properties of the

current representations of the target resource with the up­
loaded content.

OData Services
OData Service Explorer PUBLIC 215
5 OData API Monitor

You can monitor inbound OData calls with OData API Monitor.

Monitor the status of incoming calls and view the request and response payloads. This feature is useful when
troubleshooting different integration scenarios.

Scoping

OData API Monitor is available in your tenant by default. If you want to remove it, you can adjust it in your business
configuration:

1. Go to Business Configuration, choose the Implementation Projects view

2. Select your implementation project and click Edit Project Scope.
3. In the scoping wizard, choose Next until the Scoping screen appears.
4. Go to Communication and Information Exchange People Collaboration, Intranet and External Services
Communities, Document Management and External Services OData API Monitor
5. Answer the scoping question.

Launch OData Monitor

Logon to SAP Cloud for Customer and go to Administrator General Settings OData API Monitor and launch.

Once activated, all inbound calls, requests and responses are logged for one hour. You can view the HTTP status
code of incoming calls, time of call, user of call, HTTP method used and the path of the call. You can also select an
entry and view the request and response payload.

You can deactivate the trace and filter results by defining the desired search.

OData Services
216 PUBLIC OData API Monitor
6 (Deprecated) Setting Up OData
Notifications

Configure notifications and inform external systems when there are changes to SAP Cloud for Customer business
objects.

Prerequisites

 Note

The feature OData: Event Notification to External Systems is deprecated. Event Notifications is now available. For
more information, see SAP Cloud for Customer > Integration > Event Notifications

You have scoped Event Notification in business configuration. To perform this step, follow these instructions:

Go to Business Configuration, First Implementation. In step 4 (Questions) choose, Communication and

Information Exchange People Collaboration, Intranet and External Services Communities, Document
Management and External Services Under Group: Event Notification, set Do you want to use Event Notification to
inform External Applications? as In Scope.

Context

This functionality notifies external systems of changes to business objects in SAP Cloud for Customer. Use this
procedure to register your end points and set up authentication details. A typical use for this functionality is to send
a notification to SAP Commerce Cloud when a new employee is created in your C4C system, or to notify custom
applications of changes to business objects.

Procedure

1. If your HTTPS enabled endpoint uses certificates, add certificates used to the solution certificate list. Find this
list under Administrator Common Tasks Edit Certificate Trust List .

2. Navigate to the Administrator General Settings work center.

3. Choose OData Event Notification to External Systems under the Custom Object Builder section.
4. Click Add Row under Consumers, and provide the Name and Consumer End Point.

Your consumer end points must be in the public domain, must use HTTPS protocol, and must be in front of any
firewalls in your network. Additionally, consumer end points must be running an application that can

OData Services
(Deprecated) Setting Up OData Notifications PUBLIC 217
 understand and persist the following four fields: businessObject, businessObjectID, odataServiceEndpoint,
event.

 Remember

If the consumer end point is behind a firewall the connection check will fail.

5. Select Basic Authorization.

6. Click Add Row under Subscriptions.
7. Select the Business Object, OData Service, OData Entity Collection, and the event type (create, update, delete).
8. Choose a consumer endpoint in the table, and then select Check connection.
• If the connection test succeeds, then the solution will send OData Notifications to your endpoint.
• If the connection test fails, then check that your endpoint is not behind a firewall and that you have added
the certificates used by the endpoint into the certificate list.
9. Click Save.

Results

When business objects listed under any of the subscriptions are modified, the external consumer is called
asynchronously.

Example payload in JSON format:

{"businessObject":"CUSTOMER","businessObjectId":"00163E08BFEC1ED785AE497656AA26FE","oda
taServiceEndpoint":"https://my123456.ondemend.com/sap/byd/odata/v1/c4codata/
AccountCollection('00163E08BFEC1ED785AE497656AAXXXX')","event":"create"}]

The external system can call back to your C4C tenant using the URL format: https://
my123456.ondemand.com/sap/byd/odata/v1/c4codata/
AccountCollection('00163E08BFEC1ED785AE497656AAXXXX')

This call returns the details of the object modified.

OData Services
218 PUBLIC (Deprecated) Setting Up OData Notifications
7 SAP Cloud for Customer OData Developer's
Guide

The SAP Cloud for Customer OData API Developer’s Guide complements theSAP Cloud for Customer OData API
Reference with usage details and provide examples for easy convenience to developers

For more information, see SAP Cloud for Customer OData Developer’s Guide

OData Services
SAP Cloud for Customer OData Developer's Guide PUBLIC 219
8 Additional Resources

Links to additional information on SAP Cloud for Customer OData API.

Related Information

SAP Cloud for Customer Administration Guide

SAP Cloud for Customer at SAP Community

OData Services
220 PUBLIC Additional Resources
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements
with SAP) to this:

• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.

• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you
agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the
control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at
any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.

Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities, genders,
and abilities.

OData Services
Important Disclaimers and Legal Information PUBLIC 221
www.sap.com/contactsap

© 2022 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.

Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.

SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.

Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.

THE BEST RUN