GET api/audCompare/{PackageID}

Returns compare data for a single audit package

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PackageID

The PackageID of the aud.Packages table.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of audCompare
NameDescriptionTypeAdditional information
PackageID

integer

None.

ShipPackageID

integer

None.

ShipCharges

Collection of audShipCharge

None.

AuditCharges

Collection of audCarrierCharge

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PackageID": 1,
    "ShipPackageID": 1,
    "ShipCharges": [
      {
        "ShipPackageID": 1,
        "SurchargeID": 2,
        "Category": "sample string 3",
        "CategorySort": 4,
        "ChargeName": "sample string 5",
        "ChargeSort": 6,
        "ChargeAmount": 7.0,
        "MinMargin": 8.0,
        "BackBilled": true
      },
      {
        "ShipPackageID": 1,
        "SurchargeID": 2,
        "Category": "sample string 3",
        "CategorySort": 4,
        "ChargeName": "sample string 5",
        "ChargeSort": 6,
        "ChargeAmount": 7.0,
        "MinMargin": 8.0,
        "BackBilled": true
      }
    ],
    "AuditCharges": [
      {
        "CarrierChargeID": 1,
        "PackageID": 2,
        "ImportBatchID": 3,
        "ImportedByUser": "sample string 4",
        "ImportedDate": "2025-12-06T23:39:41.7312681+00:00",
        "InvoiceNumber": "sample string 5",
        "InvoiceDate": "2025-12-06T23:39:41.7312681+00:00",
        "AdditionalCharge": true,
        "ShipChargeID": 7.0,
        "BackBillChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillChargedByUser": "sample string 8",
        "BackBillChargeAmount": 9.0,
        "BackBillIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillIgnoredByUser": "sample string 10",
        "VASShippingServiceCode": "sample string 11",
        "VASClient": "sample string 12",
        "VASClientID": 13,
        "VASChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASChargedByUser": "sample string 14",
        "VASIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASIgnoredByUser": "sample string 15",
        "DefaultBillOption": "A",
        "DefaultAddAmount": 17.0,
        "DefaultAddPercent": 18.0,
        "Overcharged": true,
        "TrackingNumber": "sample string 20",
        "ShippingServiceCode": "sample string 21",
        "ShipPackageID": 22,
        "SurchargeID": 23,
        "Category": "sample string 24",
        "CategorySort": 25,
        "ChargeName": "sample string 26",
        "ChargeSort": 27,
        "ChargeAmount": 28.0,
        "MinMargin": 29.0,
        "BackBilled": true
      },
      {
        "CarrierChargeID": 1,
        "PackageID": 2,
        "ImportBatchID": 3,
        "ImportedByUser": "sample string 4",
        "ImportedDate": "2025-12-06T23:39:41.7312681+00:00",
        "InvoiceNumber": "sample string 5",
        "InvoiceDate": "2025-12-06T23:39:41.7312681+00:00",
        "AdditionalCharge": true,
        "ShipChargeID": 7.0,
        "BackBillChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillChargedByUser": "sample string 8",
        "BackBillChargeAmount": 9.0,
        "BackBillIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillIgnoredByUser": "sample string 10",
        "VASShippingServiceCode": "sample string 11",
        "VASClient": "sample string 12",
        "VASClientID": 13,
        "VASChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASChargedByUser": "sample string 14",
        "VASIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASIgnoredByUser": "sample string 15",
        "DefaultBillOption": "A",
        "DefaultAddAmount": 17.0,
        "DefaultAddPercent": 18.0,
        "Overcharged": true,
        "TrackingNumber": "sample string 20",
        "ShippingServiceCode": "sample string 21",
        "ShipPackageID": 22,
        "SurchargeID": 23,
        "Category": "sample string 24",
        "CategorySort": 25,
        "ChargeName": "sample string 26",
        "ChargeSort": 27,
        "ChargeAmount": 28.0,
        "MinMargin": 29.0,
        "BackBilled": true
      }
    ]
  },
  {
    "PackageID": 1,
    "ShipPackageID": 1,
    "ShipCharges": [
      {
        "ShipPackageID": 1,
        "SurchargeID": 2,
        "Category": "sample string 3",
        "CategorySort": 4,
        "ChargeName": "sample string 5",
        "ChargeSort": 6,
        "ChargeAmount": 7.0,
        "MinMargin": 8.0,
        "BackBilled": true
      },
      {
        "ShipPackageID": 1,
        "SurchargeID": 2,
        "Category": "sample string 3",
        "CategorySort": 4,
        "ChargeName": "sample string 5",
        "ChargeSort": 6,
        "ChargeAmount": 7.0,
        "MinMargin": 8.0,
        "BackBilled": true
      }
    ],
    "AuditCharges": [
      {
        "CarrierChargeID": 1,
        "PackageID": 2,
        "ImportBatchID": 3,
        "ImportedByUser": "sample string 4",
        "ImportedDate": "2025-12-06T23:39:41.7312681+00:00",
        "InvoiceNumber": "sample string 5",
        "InvoiceDate": "2025-12-06T23:39:41.7312681+00:00",
        "AdditionalCharge": true,
        "ShipChargeID": 7.0,
        "BackBillChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillChargedByUser": "sample string 8",
        "BackBillChargeAmount": 9.0,
        "BackBillIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillIgnoredByUser": "sample string 10",
        "VASShippingServiceCode": "sample string 11",
        "VASClient": "sample string 12",
        "VASClientID": 13,
        "VASChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASChargedByUser": "sample string 14",
        "VASIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASIgnoredByUser": "sample string 15",
        "DefaultBillOption": "A",
        "DefaultAddAmount": 17.0,
        "DefaultAddPercent": 18.0,
        "Overcharged": true,
        "TrackingNumber": "sample string 20",
        "ShippingServiceCode": "sample string 21",
        "ShipPackageID": 22,
        "SurchargeID": 23,
        "Category": "sample string 24",
        "CategorySort": 25,
        "ChargeName": "sample string 26",
        "ChargeSort": 27,
        "ChargeAmount": 28.0,
        "MinMargin": 29.0,
        "BackBilled": true
      },
      {
        "CarrierChargeID": 1,
        "PackageID": 2,
        "ImportBatchID": 3,
        "ImportedByUser": "sample string 4",
        "ImportedDate": "2025-12-06T23:39:41.7312681+00:00",
        "InvoiceNumber": "sample string 5",
        "InvoiceDate": "2025-12-06T23:39:41.7312681+00:00",
        "AdditionalCharge": true,
        "ShipChargeID": 7.0,
        "BackBillChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillChargedByUser": "sample string 8",
        "BackBillChargeAmount": 9.0,
        "BackBillIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "BackBillIgnoredByUser": "sample string 10",
        "VASShippingServiceCode": "sample string 11",
        "VASClient": "sample string 12",
        "VASClientID": 13,
        "VASChargedDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASChargedByUser": "sample string 14",
        "VASIgnoredDate": "2025-12-06T23:39:41.7312681+00:00",
        "VASIgnoredByUser": "sample string 15",
        "DefaultBillOption": "A",
        "DefaultAddAmount": 17.0,
        "DefaultAddPercent": 18.0,
        "Overcharged": true,
        "TrackingNumber": "sample string 20",
        "ShippingServiceCode": "sample string 21",
        "ShipPackageID": 22,
        "SurchargeID": 23,
        "Category": "sample string 24",
        "CategorySort": 25,
        "ChargeName": "sample string 26",
        "ChargeSort": 27,
        "ChargeAmount": 28.0,
        "MinMargin": 29.0,
        "BackBilled": true
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfaudCompare xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <audCompare>
    <AuditCharges>
      <audCarrierCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 24</Category>
        <CategorySort>25</CategorySort>
        <ChargeAmount>28</ChargeAmount>
        <ChargeName>sample string 26</ChargeName>
        <ChargeSort>27</ChargeSort>
        <MinMargin>29</MinMargin>
        <ShipPackageID>22</ShipPackageID>
        <SurchargeID>23</SurchargeID>
        <AdditionalCharge>true</AdditionalCharge>
        <BackBillChargeAmount>9</BackBillChargeAmount>
        <BackBillChargedByUser>sample string 8</BackBillChargedByUser>
        <BackBillChargedDate>2025-12-06T23:39:41.7312681+00:00</BackBillChargedDate>
        <BackBillIgnoredByUser>sample string 10</BackBillIgnoredByUser>
        <BackBillIgnoredDate>2025-12-06T23:39:41.7312681+00:00</BackBillIgnoredDate>
        <CarrierChargeID>1</CarrierChargeID>
        <DefaultAddAmount>17</DefaultAddAmount>
        <DefaultAddPercent>18</DefaultAddPercent>
        <DefaultBillOption>65</DefaultBillOption>
        <ImportBatchID>3</ImportBatchID>
        <ImportedByUser>sample string 4</ImportedByUser>
        <ImportedDate>2025-12-06T23:39:41.7312681+00:00</ImportedDate>
        <InvoiceDate>2025-12-06T23:39:41.7312681+00:00</InvoiceDate>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <Overcharged>true</Overcharged>
        <PackageID>2</PackageID>
        <ShipChargeID>7</ShipChargeID>
        <ShippingServiceCode>sample string 21</ShippingServiceCode>
        <TrackingNumber>sample string 20</TrackingNumber>
        <VASChargedByUser>sample string 14</VASChargedByUser>
        <VASChargedDate>2025-12-06T23:39:41.7312681+00:00</VASChargedDate>
        <VASClient>sample string 12</VASClient>
        <VASClientID>13</VASClientID>
        <VASIgnoredByUser>sample string 15</VASIgnoredByUser>
        <VASIgnoredDate>2025-12-06T23:39:41.7312681+00:00</VASIgnoredDate>
        <VASShippingServiceCode>sample string 11</VASShippingServiceCode>
      </audCarrierCharge>
      <audCarrierCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 24</Category>
        <CategorySort>25</CategorySort>
        <ChargeAmount>28</ChargeAmount>
        <ChargeName>sample string 26</ChargeName>
        <ChargeSort>27</ChargeSort>
        <MinMargin>29</MinMargin>
        <ShipPackageID>22</ShipPackageID>
        <SurchargeID>23</SurchargeID>
        <AdditionalCharge>true</AdditionalCharge>
        <BackBillChargeAmount>9</BackBillChargeAmount>
        <BackBillChargedByUser>sample string 8</BackBillChargedByUser>
        <BackBillChargedDate>2025-12-06T23:39:41.7312681+00:00</BackBillChargedDate>
        <BackBillIgnoredByUser>sample string 10</BackBillIgnoredByUser>
        <BackBillIgnoredDate>2025-12-06T23:39:41.7312681+00:00</BackBillIgnoredDate>
        <CarrierChargeID>1</CarrierChargeID>
        <DefaultAddAmount>17</DefaultAddAmount>
        <DefaultAddPercent>18</DefaultAddPercent>
        <DefaultBillOption>65</DefaultBillOption>
        <ImportBatchID>3</ImportBatchID>
        <ImportedByUser>sample string 4</ImportedByUser>
        <ImportedDate>2025-12-06T23:39:41.7312681+00:00</ImportedDate>
        <InvoiceDate>2025-12-06T23:39:41.7312681+00:00</InvoiceDate>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <Overcharged>true</Overcharged>
        <PackageID>2</PackageID>
        <ShipChargeID>7</ShipChargeID>
        <ShippingServiceCode>sample string 21</ShippingServiceCode>
        <TrackingNumber>sample string 20</TrackingNumber>
        <VASChargedByUser>sample string 14</VASChargedByUser>
        <VASChargedDate>2025-12-06T23:39:41.7312681+00:00</VASChargedDate>
        <VASClient>sample string 12</VASClient>
        <VASClientID>13</VASClientID>
        <VASIgnoredByUser>sample string 15</VASIgnoredByUser>
        <VASIgnoredDate>2025-12-06T23:39:41.7312681+00:00</VASIgnoredDate>
        <VASShippingServiceCode>sample string 11</VASShippingServiceCode>
      </audCarrierCharge>
    </AuditCharges>
    <PackageID>1</PackageID>
    <ShipCharges>
      <audShipCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 3</Category>
        <CategorySort>4</CategorySort>
        <ChargeAmount>7</ChargeAmount>
        <ChargeName>sample string 5</ChargeName>
        <ChargeSort>6</ChargeSort>
        <MinMargin>8</MinMargin>
        <ShipPackageID>1</ShipPackageID>
        <SurchargeID>2</SurchargeID>
      </audShipCharge>
      <audShipCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 3</Category>
        <CategorySort>4</CategorySort>
        <ChargeAmount>7</ChargeAmount>
        <ChargeName>sample string 5</ChargeName>
        <ChargeSort>6</ChargeSort>
        <MinMargin>8</MinMargin>
        <ShipPackageID>1</ShipPackageID>
        <SurchargeID>2</SurchargeID>
      </audShipCharge>
    </ShipCharges>
    <ShipPackageID>1</ShipPackageID>
  </audCompare>
  <audCompare>
    <AuditCharges>
      <audCarrierCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 24</Category>
        <CategorySort>25</CategorySort>
        <ChargeAmount>28</ChargeAmount>
        <ChargeName>sample string 26</ChargeName>
        <ChargeSort>27</ChargeSort>
        <MinMargin>29</MinMargin>
        <ShipPackageID>22</ShipPackageID>
        <SurchargeID>23</SurchargeID>
        <AdditionalCharge>true</AdditionalCharge>
        <BackBillChargeAmount>9</BackBillChargeAmount>
        <BackBillChargedByUser>sample string 8</BackBillChargedByUser>
        <BackBillChargedDate>2025-12-06T23:39:41.7312681+00:00</BackBillChargedDate>
        <BackBillIgnoredByUser>sample string 10</BackBillIgnoredByUser>
        <BackBillIgnoredDate>2025-12-06T23:39:41.7312681+00:00</BackBillIgnoredDate>
        <CarrierChargeID>1</CarrierChargeID>
        <DefaultAddAmount>17</DefaultAddAmount>
        <DefaultAddPercent>18</DefaultAddPercent>
        <DefaultBillOption>65</DefaultBillOption>
        <ImportBatchID>3</ImportBatchID>
        <ImportedByUser>sample string 4</ImportedByUser>
        <ImportedDate>2025-12-06T23:39:41.7312681+00:00</ImportedDate>
        <InvoiceDate>2025-12-06T23:39:41.7312681+00:00</InvoiceDate>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <Overcharged>true</Overcharged>
        <PackageID>2</PackageID>
        <ShipChargeID>7</ShipChargeID>
        <ShippingServiceCode>sample string 21</ShippingServiceCode>
        <TrackingNumber>sample string 20</TrackingNumber>
        <VASChargedByUser>sample string 14</VASChargedByUser>
        <VASChargedDate>2025-12-06T23:39:41.7312681+00:00</VASChargedDate>
        <VASClient>sample string 12</VASClient>
        <VASClientID>13</VASClientID>
        <VASIgnoredByUser>sample string 15</VASIgnoredByUser>
        <VASIgnoredDate>2025-12-06T23:39:41.7312681+00:00</VASIgnoredDate>
        <VASShippingServiceCode>sample string 11</VASShippingServiceCode>
      </audCarrierCharge>
      <audCarrierCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 24</Category>
        <CategorySort>25</CategorySort>
        <ChargeAmount>28</ChargeAmount>
        <ChargeName>sample string 26</ChargeName>
        <ChargeSort>27</ChargeSort>
        <MinMargin>29</MinMargin>
        <ShipPackageID>22</ShipPackageID>
        <SurchargeID>23</SurchargeID>
        <AdditionalCharge>true</AdditionalCharge>
        <BackBillChargeAmount>9</BackBillChargeAmount>
        <BackBillChargedByUser>sample string 8</BackBillChargedByUser>
        <BackBillChargedDate>2025-12-06T23:39:41.7312681+00:00</BackBillChargedDate>
        <BackBillIgnoredByUser>sample string 10</BackBillIgnoredByUser>
        <BackBillIgnoredDate>2025-12-06T23:39:41.7312681+00:00</BackBillIgnoredDate>
        <CarrierChargeID>1</CarrierChargeID>
        <DefaultAddAmount>17</DefaultAddAmount>
        <DefaultAddPercent>18</DefaultAddPercent>
        <DefaultBillOption>65</DefaultBillOption>
        <ImportBatchID>3</ImportBatchID>
        <ImportedByUser>sample string 4</ImportedByUser>
        <ImportedDate>2025-12-06T23:39:41.7312681+00:00</ImportedDate>
        <InvoiceDate>2025-12-06T23:39:41.7312681+00:00</InvoiceDate>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <Overcharged>true</Overcharged>
        <PackageID>2</PackageID>
        <ShipChargeID>7</ShipChargeID>
        <ShippingServiceCode>sample string 21</ShippingServiceCode>
        <TrackingNumber>sample string 20</TrackingNumber>
        <VASChargedByUser>sample string 14</VASChargedByUser>
        <VASChargedDate>2025-12-06T23:39:41.7312681+00:00</VASChargedDate>
        <VASClient>sample string 12</VASClient>
        <VASClientID>13</VASClientID>
        <VASIgnoredByUser>sample string 15</VASIgnoredByUser>
        <VASIgnoredDate>2025-12-06T23:39:41.7312681+00:00</VASIgnoredDate>
        <VASShippingServiceCode>sample string 11</VASShippingServiceCode>
      </audCarrierCharge>
    </AuditCharges>
    <PackageID>1</PackageID>
    <ShipCharges>
      <audShipCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 3</Category>
        <CategorySort>4</CategorySort>
        <ChargeAmount>7</ChargeAmount>
        <ChargeName>sample string 5</ChargeName>
        <ChargeSort>6</ChargeSort>
        <MinMargin>8</MinMargin>
        <ShipPackageID>1</ShipPackageID>
        <SurchargeID>2</SurchargeID>
      </audShipCharge>
      <audShipCharge>
        <BackBilled>true</BackBilled>
        <Category>sample string 3</Category>
        <CategorySort>4</CategorySort>
        <ChargeAmount>7</ChargeAmount>
        <ChargeName>sample string 5</ChargeName>
        <ChargeSort>6</ChargeSort>
        <MinMargin>8</MinMargin>
        <ShipPackageID>1</ShipPackageID>
        <SurchargeID>2</SurchargeID>
      </audShipCharge>
    </ShipCharges>
    <ShipPackageID>1</ShipPackageID>
  </audCompare>
</ArrayOfaudCompare>