GET api/pharmacyheadquarters?nameFilter={nameFilter}

Gets a collection of Pharmacy Headquarters for the company of the authenticated user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
nameFilter

Optional querystring filter that does a starts with comparison (Example: api/pharmacyheadquarters?nameFilter=[value]).

 string

None.

Body Parameters

None.

Response Information

Resource Description

A list of Pharmacy Headquarters.

Collection of PharmacyHeadquarterModel
NameDescriptionTypeAdditional information
Description

Gets or sets the description of the HQ

 string

None.
FederalTaxID

Gets or sets the federal tax id for the HQ

 string

None.
Notes

Gets or sets the notes for the HQ

 string

None.
NetworkAccessFee

Gets or sets the fee for submitted claims

 decimal number

None.
NetworkAccessFeeManualClaim

Gets or sets the fee for manually submitted claims

 decimal number

None.
Inactive

Gets or sets whether the HQ is inactive

 boolean

None.
NetworkAccessFeeUsualAndCustomary

Gets or sets the fee for claims that use usual and customary

 decimal number

None.
NetworkAccessFeeManualClaimUsualAndCustomary

Gets or sets the fee for manual claims that use usual and customary

 decimal number

None.
ParentCode

Gets or sets the parent organization

 string

None.
DefaultPaymentPayablesCenterNo

Gets or sets Default Payment Payables Center

 integer

None.
DefaultPaymentPayablesCenterUrl

Gets or sets the Default Payment Payables Center Url

 string

None.
DefaultRemitPayablesCenterNo

Gets or sets Default Remit Payables Center

 integer

None.
DefaultRemitPayablesCenterUrl

Gets or sets the Default Remit Payables Center Url

 string

None.
AlwaysUseDefaultPaymentPayablesCenter

Gets or sets value for whether to Always Use Default Payment Payables Center

 boolean

None.
AlwaysUseDefaultRemitPayablesCenter

Gets or sets value for whether to Always Use Default Remit Payables Center

 boolean

None.
NetworkAccessFeeReversalNo

Gets or sets type of reversals allowed for Network Access Fee for submitted claims

 integer

None.
NetworkAccessFeeReversalUrl

Gets or sets the Network Access Fee Reversal Url

 string

None.
NetworkAccessFeeManualClaimReversalNo

Gets or sets type of reversals allowed for Network Access Fee Manual Claims

 integer

None.
NetworkAccessFeeManualClaimReversalUrl

Gets or sets the Network Access Fee Manual Claim Reversal Url

 string

None.
NetworkAccessFeeUsualAndCustomaryReversalNo

Gets or sets type of reversals allowed for Network Access Fee (U/C)

 integer

None.
NetworkAccessFeeUsualAndCustomaryReversalUrl

Gets or sets the Network Access Fee Usual and Customary Reversal Url

 string

None.
NetworkAccessFeeManualClaimUsualAndCustomaryReversalNo

Gets or sets types of reversal allowed for Network Access Fee Manual (U/C)

 integer

None.
NetworkAccessFeeManualClaimUsualAndCustomaryReversalUrl

Gets or sets the Network Access Fee Manual Claim Usual and Customary Reversal Url

 string

None.
FallbackPharmacyHeadquarterNo

Gets or sets fallback pharmacy headquarters

 integer

None.
FallbackPharmacyHeadquarterUrl

Gets or sets the Fallback Pharmacy Headquarter Url

 string

None.
HeadquarterPricingPlansUrl

Gets or sets the Headquarter Pricing Plans Url. These represent the headquarter plans used for pricing that are editable from the Global > Pharmacy HQ Maintenance page in the grid labeled "Pricing". The endpoint at this URL only contains the HQ Plans, not the global plans. Use the HeadquarterGlobalPricingPlansUrl to navigate to the global plans for this Pharmacy HQ.

 string

None.
HeadquarterGlobalPricingPlansUrl

Gets or sets the Headquarter Global Pricing Plans Url. These represent the global headquarter plans used for pricing that are editable from the Global > Pharmacy HQ Maintenance page in the grid labeled "Pricing" - those plans marked "Y" for global. The endpoint at this URL only contains the global plans used for pricing. Use the HeadquarterPricingPlansUrl to navigate to the non-global plans for this Pharmacy HQ.

 string

None.
PharmacyLocationsUrl

Gets or sets the Pharmacy Locations Url

 string

None.
RelationshipCodes

Gets or sets the Relationship Code list

 Collection of PharmacyHeadquarterCodeModel

None.
Networks

Gets or sets Network list

 Collection of NetworkPharmacyHeadquarterModel

None.
PayablesCentersUrl

Gets or sets the Payables Centers Url

 string

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 18",
    "id": 19,
    "description": "sample string 1",
    "federalTaxID": "sample string 2",
    "notes": "sample string 3",
    "networkAccessFee": 1.0,
    "networkAccessFeeManualClaim": 1.0,
    "inactive": true,
    "networkAccessFeeUsualAndCustomary": 1.0,
    "networkAccessFeeManualClaimUsualAndCustomary": 1.0,
    "parentCode": "sample string 4",
    "defaultPaymentPayablesCenterNo": 1,
    "defaultPaymentPayablesCenterUrl": "sample string 5",
    "defaultRemitPayablesCenterNo": 1,
    "defaultRemitPayablesCenterUrl": "sample string 6",
    "alwaysUseDefaultPaymentPayablesCenter": true,
    "alwaysUseDefaultRemitPayablesCenter": true,
    "networkAccessFeeReversalNo": 1,
    "networkAccessFeeReversalUrl": "sample string 9",
    "networkAccessFeeManualClaimReversalNo": 1,
    "networkAccessFeeManualClaimReversalUrl": "sample string 10",
    "networkAccessFeeUsualAndCustomaryReversalNo": 1,
    "networkAccessFeeUsualAndCustomaryReversalUrl": "sample string 11",
    "networkAccessFeeManualClaimUsualAndCustomaryReversalNo": 1,
    "networkAccessFeeManualClaimUsualAndCustomaryReversalUrl": "sample string 12",
    "fallbackPharmacyHeadquarterNo": 1,
    "fallbackPharmacyHeadquarterUrl": "sample string 13",
    "headquarterPricingPlansUrl": "sample string 14",
    "headquarterGlobalPricingPlansUrl": "sample string 15",
    "pharmacyLocationsUrl": "sample string 16",
    "relationshipCodes": [
      {
        "url": "sample string 4",
        "id": 5,
        "code": "sample string 1",
        "relationshipName": "sample string 2",
        "relationshipType": "sample string 3"
      },
      {
        "url": "sample string 4",
        "id": 5,
        "code": "sample string 1",
        "relationshipName": "sample string 2",
        "relationshipType": "sample string 3"
      }
    ],
    "networks": [
      {
        "url": "sample string 6",
        "id": 7,
        "pharmacyHeadquarterNo": 1,
        "pharmacyHeadquarterName": "sample string 2",
        "pharmacyHeadquarterInactive": true,
        "planNo": 1,
        "planName": "sample string 3",
        "networkNo": 1,
        "networkName": "sample string 4",
        "comment": "sample string 5"
      },
      {
        "url": "sample string 6",
        "id": 7,
        "pharmacyHeadquarterNo": 1,
        "pharmacyHeadquarterName": "sample string 2",
        "pharmacyHeadquarterInactive": true,
        "planNo": 1,
        "planName": "sample string 3",
        "networkNo": 1,
        "networkName": "sample string 4",
        "comment": "sample string 5"
      }
    ],
    "payablesCentersUrl": "sample string 17"
  },
  {
    "url": "sample string 18",
    "id": 19,
    "description": "sample string 1",
    "federalTaxID": "sample string 2",
    "notes": "sample string 3",
    "networkAccessFee": 1.0,
    "networkAccessFeeManualClaim": 1.0,
    "inactive": true,
    "networkAccessFeeUsualAndCustomary": 1.0,
    "networkAccessFeeManualClaimUsualAndCustomary": 1.0,
    "parentCode": "sample string 4",
    "defaultPaymentPayablesCenterNo": 1,
    "defaultPaymentPayablesCenterUrl": "sample string 5",
    "defaultRemitPayablesCenterNo": 1,
    "defaultRemitPayablesCenterUrl": "sample string 6",
    "alwaysUseDefaultPaymentPayablesCenter": true,
    "alwaysUseDefaultRemitPayablesCenter": true,
    "networkAccessFeeReversalNo": 1,
    "networkAccessFeeReversalUrl": "sample string 9",
    "networkAccessFeeManualClaimReversalNo": 1,
    "networkAccessFeeManualClaimReversalUrl": "sample string 10",
    "networkAccessFeeUsualAndCustomaryReversalNo": 1,
    "networkAccessFeeUsualAndCustomaryReversalUrl": "sample string 11",
    "networkAccessFeeManualClaimUsualAndCustomaryReversalNo": 1,
    "networkAccessFeeManualClaimUsualAndCustomaryReversalUrl": "sample string 12",
    "fallbackPharmacyHeadquarterNo": 1,
    "fallbackPharmacyHeadquarterUrl": "sample string 13",
    "headquarterPricingPlansUrl": "sample string 14",
    "headquarterGlobalPricingPlansUrl": "sample string 15",
    "pharmacyLocationsUrl": "sample string 16",
    "relationshipCodes": [
      {
        "url": "sample string 4",
        "id": 5,
        "code": "sample string 1",
        "relationshipName": "sample string 2",
        "relationshipType": "sample string 3"
      },
      {
        "url": "sample string 4",
        "id": 5,
        "code": "sample string 1",
        "relationshipName": "sample string 2",
        "relationshipType": "sample string 3"
      }
    ],
    "networks": [
      {
        "url": "sample string 6",
        "id": 7,
        "pharmacyHeadquarterNo": 1,
        "pharmacyHeadquarterName": "sample string 2",
        "pharmacyHeadquarterInactive": true,
        "planNo": 1,
        "planName": "sample string 3",
        "networkNo": 1,
        "networkName": "sample string 4",
        "comment": "sample string 5"
      },
      {
        "url": "sample string 6",
        "id": 7,
        "pharmacyHeadquarterNo": 1,
        "pharmacyHeadquarterName": "sample string 2",
        "pharmacyHeadquarterInactive": true,
        "planNo": 1,
        "planName": "sample string 3",
        "networkNo": 1,
        "networkName": "sample string 4",
        "comment": "sample string 5"
      }
    ],
    "payablesCentersUrl": "sample string 17"
  }
]