PATCH api/formularies/{formularyid}/formularycompanyquantitylimits/{id}

Patches an existing Formulary Company Quantity Limit object

Request Information

URI Parameters

Name	Description	Type	Additional information
formularyid	The id of the formulary for which quantity limits	integer	Required
id	Quantity limit identifier	integer	Required

Body Parameters

The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target formulary company quantity limit object

JsonPatchDocument

Name	Description	Type	Additional information
Operations		Collection of Operation	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/json-patch+json

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A patched Formulary Company Quantity Limit object

FormularyCompanyQuantityLimitModel

Name	Description	Type	Additional information
CompanyQuantityLimitNo	Gets or sets the value indicating whether this formulary quantity limit is inheriting from a global/company-level quantity limit.	integer	None.
CompanyQuantityLimitUrl	Gets the url where the global/company-level quantity limit resource can be found	string	None.
ProductID	Gets or sets the product ID for this resource. The value should be a valid NDC, DDID or GPI.	string	None.
ProductIDType	Gets or sets the product ID Type for this resource. The value will indicate whether the product ID for this resource is an NDC or DDID . String values other than 'NDC' or 'DDID' will not be valid.	string	None.
MaxAmount	Gets or sets the Max Amount for this resource	decimal number	None.
MaxAmountQualifier	Gets or sets the two letter code representing the qualifier for the max amount value DS - Days Supply FL - Fills DL - Dollar Amount QY - Quantity	MaxAmountQualifier	None.
MaxAmountTimePeriod	Gets or sets the two letter code representing the time period for the max amount SP - Specific Date Range DY - Days CM - Calendar Month LT - Lifetime CY - Calendar Year PD - Per Dispensing CQ - Calendar Quarter	MaxAmountTimePeriod	None.
MaxAmountTimePeriodStartDate	Gets or sets the Max Amount Time Period Start Date	date	None.
MaxAmountTimePeriodEndDate	Gets or sets the Max Amount Time Period End Date	date	None.
MaxAmountTimePeriodUnits	Gets or sets the units to use in combination with the max amount time period (e.g. MaxAmountTimePeriodUnits=30 and a MaxAmountTimePeriod of 'DY' would indicate 30 days)	string	None.
EffectiveStartDate	Gets or sets the Effective Start Date of this resource	date	None.
EffectiveEndDate	Gets or sets the Effective End Date of this resource	date	None.
Active	Gets or sets the Active status for this resource	boolean	None.
Url	Gets or sets the link representing a link back to the resource	string	None.
ID	Gets or sets the identifier for the resource	integer	None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "url": "sample string 5",
  "id": 6,
  "companyQuantityLimitNo": 1,
  "companyQuantityLimitUrl": "sample string 1",
  "productID": "sample string 2",
  "productIDType": "sample string 3",
  "maxAmount": 1.0,
  "maxAmountQualifier": 0,
  "maxAmountTimePeriod": 0,
  "maxAmountTimePeriodStartDate": "2025-05-30T20:45:51.8416618-05:00",
  "maxAmountTimePeriodEndDate": "2025-05-30T20:45:51.8416618-05:00",
  "maxAmountTimePeriodUnits": "sample string 4",
  "effectiveStartDate": "2025-05-30T20:45:51.8416618-05:00",
  "effectiveEndDate": "2025-05-30T20:45:51.8416618-05:00",
  "active": true
}