Model

sapimclient.model

Data models for Python SAP Incentive Management Client.

Read the API Documentation

Visit https://{TENANT}.callidusondemand.com/APIDocument to read the full specification, replacing TENANT with your tenant-id.

Most of these models are undocumented. For a complete list of attributes, refer to the API documentation. Attribute names are converted to snake_case to follow standard python conventions.

All models support the read methods of Tenant, refer to the API documentation for a full list of supported methods.

Base

sapimclient.model.base

Pydantic models for Python SAP Incentive Management Client.

These classes are generally not used directly but can be usefull for type checking and type hints. Used to inherrit function on all other models.

class sapimclient.model.base._BaseModel[source]

Bases: BaseModel

BaseModel inherited from pydantic.BaseModel.

Contains the primary model_config which is required for Pydantic to convert field names between snake_case and camelCase when sending and recieving json data from/to the SAP Incentive Management tenant.

classmethod typed_fields(typed: type | tuple[type, ...]) → dict[str, FieldInfo][source]

Return model fields of the specified type.

This method can be usefull when converting data types for example.

Returns:: A dictionary of attributes annotated with the specified type where the keys are attribute names and the values are FieldInfo objects.

class sapimclient.model.base.Endpoint[source]

Bases: _BaseModel

Base class for resources that can connect with the client.

Parameters:: attr_endpoint (str) – URI endpoint to connect with tenant. Must follow format api/v2/nameOfResource. Used by the client to construct the full request url.

classmethod expands() → dict[str, FieldInfo][source]

Return model fields that refer to another model class.

This function is primarily used by the client to add the expand parameter to the request.

Returns:: A dictionary of attributes that can be expanded where the keys are attribute names and the values are FieldInfo objects.

class sapimclient.model.base.Resource[source]

Bases: Endpoint

Base class for a resource.

Every resource has it’s own attribute that uniquely identifies the object on the tenant. Inheritance of this class allows us to refer to the system unique identifier without having to address it directly.

Example

Attributes seq and credit_seq are equal:

assert Credit.seq == Credit.credit_seq

Parameters:: attr_seq (str) – Name of attribute that contains the system unique identifier (seq).

property seq: str | None: System unique identifier (seq) of the resource instance.

class sapimclient.model.base.AdjustmentContext[source]

Bases: _BaseModel

Adjustment Context for SalesTransaction.

Used only when updating the value of a SalesTransaction.

Parameters:

adjust_type_flag (Literal["adjustTo", "adjustBy", "reset"]) –
- adjustTo
- adjustBy
- reset
adjust_to_value (Value | None) – Adjust value to this amount.
adjust_by_value (Value | None) – Adjust value by this amount.
comment (str | None) – Adjustment comment.

class sapimclient.model.base.Value[source]

Bases: _BaseModel

Value object used by all numeric fields.

Parameters:

value (int | float | None) – The amount.
unit_type (ValueUnitType) – Type of amount.

class sapimclient.model.base.ValueClass[source]

Bases: _BaseModel

Value Class, used only by UnitType.

Parameters:: display_name (str) – Name of the value class.

class sapimclient.model.base.ValueUnitType[source]

Bases: _BaseModel

Unit Type of for Value.

Parameters:

name (str) – Name of the unit type.
unit_type_seq (str) – System unique identifier.

class sapimclient.model.base.Reference[source]

Bases: Expandable

Expanded reference to a resource.

Parameters:

key (str) – System unique identifier for the referred resource.
display_name (str) – Name of the referred resource.
object_type (type[model.Resource]) – Class of the referred resource.
key_string (str) – Seems to always be the same as key.
logical_keys (dict[str, str | int | Value | Any]) – Some key attributes of the referred resource.

class sapimclient.model.base.Assignment[source]

Bases: _BaseModel

Assignment.

Used by Pipeline to refer to stage tables and by Plan, Title and Position to refer to Variable Assignments.

Parameters:

key (str | None) – Not sure really.
owned_key (str | None) – Also not sure really.

TODO: Is this an expandable reference?

class sapimclient.model.base.BusinessUnitAssignment[source]

Bases: _BaseModel

Business Unit Assignment.

Used by AuditLog and Rule to refer to Business Units.

Parameters:

mask (int) – Not sure really.
smask (int) – Seems to be the same as mask.

TODO: Is this an expandable reference?

class sapimclient.model.base.RuleUsage[source]

Bases: _BaseModel

Rule Usage.

Used by Rule and Rule Elements for some reason.

Parameters:

id (str) – ID
name (str) – Name

TODO: Is this an expandable reference?

class sapimclient.model.base.RuleUsageList[source]

Bases: _BaseModel

List of RuleUsage.

Parameters:: children (list[RuleUsage]) – List of RuleUsage elements.

TODO: Is this an expandable reference? TODO: Make this class accessible as iterator of RuleUsage.

class sapimclient.model.base.SalesTransactionAssignment[source]

Bases: Expandable, Generic16Mixin

Expanded reference to a transaction assignment.

Parameters:

payee_id (str | None) – Participant ID assigned to the transaction.
position_name (str | None) – Position Name assigned to the transaction.
title_name (str | None) – Title Name assigned to the transaction.
sales_order (str | None) – Order ID of the transaction.
sales_transaction_seq (str) – System unique identifier of the transaction.
set_number (int | None) – Index of the Assignment.
compensation_date (datetime | None) – Compensation Date of the transaction.
processing_unit (str | None) – System unique identifier of the Processing Unit.
ga{1-16} (str | None) – Generic Attributes.
gn{1-6} (Value | None) – Generic Numbers.
gd{1-6} (datetime | None) – Generic Dates.
gb{1-6} (bool | None) – Generic Booleans.

Data Type

sapimclient.model.data_type

Pydantic models for Data Type Resources.

class sapimclient.model.data_type._DataType[source]

Model

Base

Data Type

Rule Elements

Rule Element Owners

Resource

Pipeline