# Save Products

Save Products

Endpoint: POST /rest/2.0/PRODUCT
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Id` (string, required)
    ID: PRODUCT_ID

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.Name` (string, required)
    Product Name: PRODUCT_NAME

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.OverridePermissions` (string)
    Override Permissions: Sets the rating method and price override options during provisioning. No Restriction: Rating method and rate can be changed during provisioning.Restrict Rating Method Override: (Default) Selecting this will restrict the ability to change the rating method when provisioning products. The price can still be changed.Restrict Rate Override: Selecting this will restrict the ability to change the rating method and price when provisioning products.

  - `brmObjects.CustomizeTaxRules` (integer)
    Customize Tax Rules: When selected, it allows the administrator to specify the tax product that will be applied to the product.

  - `brmObjects.RatingMethodId` (string)
    Rating Method: Specifies the rating method applied to the product. See the Rating Methods Overview topic for more information.

  - `brmObjects.ContractRequiredFlag` (integer)
    Contractual Rate Source Required: When selected, the product will use the current rate only from the contract rating level.                        If there is not any valid contract rate in the existing contracts, an alert will be generated.                        The usage product will first derive its contract rate from the linked contract of the billing identifier account product,                        which associates the usage product with the Account then other contract rates may be used

  - `brmObjects.DefaultRateFlag` (integer)
    DefaultRateFlag

  - `brmObjects.Rate` (string)
    Rate

  - `brmObjects.ExternalKey` (string)
    ExternalKey

  - `brmObjects.OrderOfExecution` (string)
    Order Of Execution: This field sequences the order in which calculations of products occurring at invoice close time happen - sequenced by lowest to highest value. Calculations of products with the same execution order value are performed in parallel, therefore never assign the same or smaller execution order value to a products referencing the outcome of earlier calculations.

  - `brmObjects.UseFormulaSSP` (integer)
    Use Formula SSP (Rev Rec): If checked, system will ignore the SSP added to the rate and use a formula instead.

  - `brmObjects.RestrictUseOfUnreferencedContracts` (integer)
    Restrict Use Of Unreferenced Contracts: When selected, the product will use the current rate only from the Account Product contract.                        If there is no valid contract rate, an alert will be generated.                        The usage product will derive its contract rate only from the linked contract of the billing identifier account product,                        which associates the usage product with the Account

  - `brmObjects.SfRecordId` (string)
    Salesforce Record ID

  - `brmObjects.SfSyncBatchId` (string)
    Salesforce Batch ID

  - `brmObjects.SfStatusError` (string)
    Salesforce Sync Status

  - `brmObjects.SfLastSync` (string)
    Salesforce Last Sync

  - `brmObjects.Ranking` (string)
    Ranking

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.SSPFormula` (string)
    Formula SSP

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Id` (string)
    ID: PRODUCT_ID

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.Name` (string)
    Product Name: PRODUCT_NAME

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.OverridePermissions` (string)
    Override Permissions: Sets the rating method and price override options during provisioning. No Restriction: Rating method and rate can be changed during provisioning.Restrict Rating Method Override: (Default) Selecting this will restrict the ability to change the rating method when provisioning products. The price can still be changed.Restrict Rate Override: Selecting this will restrict the ability to change the rating method and price when provisioning products.

  - `retrieveResponse.CustomizeTaxRules` (integer)
    Customize Tax Rules: When selected, it allows the administrator to specify the tax product that will be applied to the product.

  - `retrieveResponse.RatingMethodId` (string)
    Rating Method: Specifies the rating method applied to the product. See the Rating Methods Overview topic for more information.

  - `retrieveResponse.ContractRequiredFlag` (integer)
    Contractual Rate Source Required: When selected, the product will use the current rate only from the contract rating level.                        If there is not any valid contract rate in the existing contracts, an alert will be generated.                        The usage product will first derive its contract rate from the linked contract of the billing identifier account product,                        which associates the usage product with the Account then other contract rates may be used

  - `retrieveResponse.DefaultRateFlag` (integer)
    DefaultRateFlag

  - `retrieveResponse.Rate` (string)
    Rate

  - `retrieveResponse.ExternalKey` (string)
    ExternalKey

  - `retrieveResponse.OrderOfExecution` (string)
    Order Of Execution: This field sequences the order in which calculations of products occurring at invoice close time happen - sequenced by lowest to highest value. Calculations of products with the same execution order value are performed in parallel, therefore never assign the same or smaller execution order value to a products referencing the outcome of earlier calculations.

  - `retrieveResponse.UseFormulaSSP` (integer)
    Use Formula SSP (Rev Rec): If checked, system will ignore the SSP added to the rate and use a formula instead.

  - `retrieveResponse.RestrictUseOfUnreferencedContracts` (integer)
    Restrict Use Of Unreferenced Contracts: When selected, the product will use the current rate only from the Account Product contract.                        If there is no valid contract rate, an alert will be generated.                        The usage product will derive its contract rate only from the linked contract of the billing identifier account product,                        which associates the usage product with the Account

  - `retrieveResponse.SfRecordId` (string)
    Salesforce Record ID

  - `retrieveResponse.SfSyncBatchId` (string)
    Salesforce Batch ID

  - `retrieveResponse.SfStatusError` (string)
    Salesforce Sync Status

  - `retrieveResponse.SfLastSync` (string)
    Salesforce Last Sync

  - `retrieveResponse.Ranking` (string)
    Ranking

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.SSPFormula` (string)
    Formula SSP

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error