Pricing Policy

The Pricing Policy object contains the following attributes:

Field	Type	Description
id	string	(Read-only) The identifier of the pricing policy.
client	object, core	(Read-only) The client account to which the pricing policy belongs.
markup	decimal	The markup that has been applied to the yield cap. Optional on request: if omitted, the markup requires a margin to be provided. Only SoftwareOne operations can view this field.
margin	decimal	The margin of the yield cap. Optional on request: if omitted, the markup requires a margin to be provided. Only SoftwareOne operations can view this field.
products	object, core	Represents the product object, containing a list of selected products. Example: [ { "id": "PRD-1111-1111-1111", "name": "Microsoft Office 365 NCE", "icon": "/static/PRD-1111-1111-1111/logo.png" } ]
status	enum	Indicates the status of the price policy. Allowed values are: Active Disabled Deleted
eligibility	decimal	Indicates whether the policy applies to clients (Tier 1), partners (Tier 2), or both. Example: [ "client": true, "partner": false ]
name	string, core	The name of the pricing policy.
externalIds	object	Represents the externalIds object.
notes	string	User notes about the pricing policy.
statistics	object	Represents the pricingPolicyStatistics object.
audit	object	(Read-only) Represents the audit object.

Pricing Policy Attachment object

This object contains the following attributes:

Field	Type	Description
id	string	The ID of the attachment.
name	string, core	The name of the attachment.
type	string	The type of file.
size	integer	The size of the file.
description	string, core	A description of the attachment.
fileName	string	The name of the file.
contentType	string	Indicates the content type.
status	enum, core	Indicates the status of the pricing policy attachment.
audit	object	Represents the audit object.

Pricing Policy Statistics object

This object contains the following attributes:

Field	Type	Description
orders	number	The number of orders assigned to the policy.
attachments	number	The number of attachments assigned to the policy.

Eligibility object

This object contains the following attributes:

Field	Type	Description
client	boolean	Indicates direct clients.
partner	boolean	Indicates indirect clients, also called partner.

Example

PRICING POLICY OBJECT

{
    "id": "PRP-1234-1222-5678",   
    "client": {
        "id": "ACC-1234-1222",        
        "name": "Microsoft",
        "icon": "/static/ACC-1234-1222/account.png"
    },
    "markup": "0.5013",
    "margin": "0.3339",
    "products": [
      {
        "id": "PRD-1111-1111-1111",        
        "name": "Microsoft Office 365 NCE",
        "icon": "/static/PRD-1111-1111-1111/logo.png"
      }
    ],
    "status": "Active",
    "name": "PRP for Stark Industries",
    "externalIds": {
        "operations": "op-322-322"
    },
    "notes": "This is the primary Pricing Policy for the EU region",
    "statistics": {
        "orders": 2,
        "attachments": 1
    }
}