inventory adjustmentcharges (http://api.3plcentral.com/rels/inventory/adjustmentcharges)
Resource:
Collection: of adjustment
C# Rel Const:
Rels.InventorySvc.AdjustmentCharges
URI template:
adjustmentcharges/{customerId}
Obtain URI from:
Retrieves the adjustment proposed charges for a specific customer
Success status: 200
Name (* = required) Data Type Description
customerId * int
The embedded AdjustmentItems collection contains receive items with positive quantity (inventory increases) and negative quantity (inventory decreases)
Type Description
ReadOnly Inventory.Models.AdjustmentReadOnly
AdjustmentId int
SubType Common.Enum.SubType
- 0: None
- 1: TransferTo corresponds to a receiver-like adjustment, hence same numeric value as WarehouseTransactionType Inbound
- 2: TransferFrom corresponds to an order-like adjustment, hence same numeric value as WarehouseTransactionType Order
RelatedAdjustmentId int? ...
ProcessDate DateTime? ...
ReferenceNum string
PONumber string
Notes string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
WarehouseTransactionSourceType Common.Enum.WarehouseTransactionSourceType? ... how the transaction entered the system
- 0: Unknown
- 1: UiManual
- 2: UiImport
- 3: AutomatedImport
- 4: ExternalSoapApi
- 5: QuickBooksSoapApi
- 6: AutomatedSystemCharge
- 7: RestApi
TransactionEntryType Common.Enum.TransactionEntryType? ... the agent creating the transaction
- 0: DoangHair unknown
- 1: ManualWarehouseUser
- 2: ManualCustomerUser
- 3: Ftp
- 4: Api
ImportChannelIdentifier Generic.Models.ChannelIdentifier reference to the channel trhough which this order was imported
Name string
Id int
CreationDate DateTime? ...
CreatedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
LastModifiedDate DateTime? ...
LastModifiedByIdentifier Generic.Models.UserIdentifier
Name string
Id int
Status Common.Enum.WarehouseTransactionApiStatus For GET of orders and receivers, the value is reliable. For rql for orders, this property is reliable only for "Canceled" status; otherwise use the IsClosed property.
- 0: Open Has not yet been confirmed
- 1: Closed Has been confirmed
- 2: Canceled Has been canceled
AdjustmentItems IList<Inventory.Models.AdjustmentItem>
Qty decimal? ... the Qty by which inventory was increased or decreased
ReadOnly Inventory.Models.ReceiveItemReadOnly provided when GETting, ignored when POSTing new or PUTting existing single receive item, required when PUTting list of receive items
ReceiveItemId int when PUTting a receiver or a receive item list, zero to create a new receiver item, otherwise it identifies an existing receive item
FullyShippedDate DateTime? ...
UnitIdentifier Generic.Models.UnitOfMeasureIdentifier for convenience, referenced item's primary inventory unit
Name string
Id int
SecondaryUnitIdentifier Generic.Models.UnitOfMeasureIdentifier for convenience, referenced item's secondary inventory unit if defined
Name string
Id int
ExpectedQty decimal? ... when a ReceiveAgainst receiver is converted to a normal receiver, ExpectedQty is automatically copied from PrimaryQty; otherwise the ExpectedQty is null
InventoryLevels Inventory.Models.InventoryLevels from StockStatus
OnHand decimal in the warehouse
Available decimal in the warehouse but not allocated to any order
SecondaryAvailable decimal? ...
OnHoldDate DateTime? ... The date the receive item was most recently placed on hol
OnHoldUserIdentifier Generic.Models.UserIdentifier the user who most recently place the receive item on hold
Name string
Id int
FacilityIdentifier Generic.Models.FacilityIdentifier the facility where the receive item was received
Name string
Id int
ReferenceNumber string The Reference number of the receipt containing this receiveItem
TransactionID int The Transaction ID containing this receiveItem
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string item qualifer; null is interpreted same as empty string
ExternalId string connection of this receive item to the same receive item on some other system
SecondaryQty decimal? ... if not specified and Item.Options.SecondaryUnit defined will be calculated from Qty; error if specified and Item.Options.SecondaryUnit null
LotNumber string item must be enabled for lot numbers to use this field
SerialNumber string item must be enabled for serial numbers to use this field
ExpirationDate DateTime? ... item must be enabled for expiration dates to use this field
Cost decimal? ... item must be enabled for cost to use this field
SupplierIdentifier Generic.Models.ContactIdentifier customer must be enabled for suppliers to use this field
Name string
Id int
LocationInfo Inventory.Models.LocationInfo customer must be enabled for locations to use this field
Inventory.Models.LocationInfo in GETs: the location; in POSTs or PUTs: identifies existing location or properties of new location more...
LocationId int? ... for identifying: if known specify only this; other fields are ignored
Display string specify either Display or RawField1..n but not both
RawField1 string "Raw" means as the user envisions it without the internal magnitude notation applied for sorting
RawField2 string
RawField3 string
RawField4 string
PalletInfo Inventory.Models.PalletInfo customer must be enabled for movable units to use this field
Inventory.Models.PalletInfo in GETs: the movable unit; in POSTs or PUTs: identifies existing movable unit or properties of new movable unit more...
PalletId int? ... for identifying: if known specify only this; other fields are ignored
Label string for identifying: if known but PalletId unknown, specify label, other fields ignored; for creating: new unique label or leave blank for system to generate unique label number
SplitOverCapacityOnCreate bool? ... if true will use PalletInfo as template to create multiples and splits associated receive items accordingly
QtyOverrideOnSplit decimal? ... when creating and SplitOverCapacityOnCreate is true, overrides the Item.Options.Pallets.Qty otherwise used to create multiples
PalletTypeIdentifier Generic.Models.PalletTypeIdentifier required when creating new movable unit
Name string
Id int
Metric Generic.Models.Dimension optional when creating; if only Metric specified, Imperial is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
Imperial Generic.Models.Dimension optional when creating; if only Imperial specified, Metric is calculated
Length decimal? ...
Width decimal? ...
Height decimal? ...
Weight decimal? ...
WeightImperial decimal? ... total weight of receive item, imperial; if specified and metric not specified, business logic computes metric more...
WeightMetric decimal? ... total weight of receive item, metric; if specified and imperial not specified, business logic computes imperial; see WeightImperial for further explanation
OnHold bool If true, this receive item is not available for allocation
OnHoldReason string the reason the receive item was placed on hold; required if OnHold is true
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
CondensedSEs string a condensed string of the saved Elements, used as a groupBy value
Billing Generic.Models.Billing
BillingCharges ICollection<Generic.Models.BillingCharge> PUT: set to NULL or empty to delete all charges
ChargeType Common.Enum.PriceCalcFieldType charge type
- 1: Handling
- 2: Storage
- 3: PrepaidFreight
- 4: ThirdPartyFreight
- 5: SpecialCharges
- 6: Materials
- 7: AutoCalcStorage used internally for sys-gen'ed charges
- 8: AutoCalcHandling used internally for sys-gen'ed charges
- 8: MAXVAL ignore, not a real value
Subtotal decimal
Details ICollection<Generic.Models.BillingChargeDetail>
WarehouseTransactionPriceCalcId int
NumUnits decimal
ChargeLabel string
UnitDescription string
ChargePerUnit decimal
GlAcctNum string
Sku string
PtItem string
PtItemDescription string
PtArAcct string
SystemGenerated bool
TaxCode string Empty on GET. If present on POST or PUT, may create or update a "matching" PriceCalcRate record to be used while generating invoices
RecurringChargeDetails IEnumerable<Generic.Models.RecurringChargeDetail> On GET of charge Adjustments only
RecurringBillingDetailId int
ReceiveItemId int
OnHandAtBillTime decimal
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
LotNumber string
SerialNumber string
ExpirationDate DateTime? ...
Cost decimal? ...
SupplierIdentifier Generic.Models.ContactIdentifier
Name string
Id int
LocationIdentifier Generic.Models.LocationIdentifier
NameKey Generic.Models.LocationNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
PalletIdentifier Generic.Models.PalletIdentifier
NameKey Generic.Models.PalletNameKey
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
Name string
Id int
SavedElements IEnumerable<Generic.Models.SavedElement>
Name string
Value string
RowVersion string
Sample accept: application/hal+json
{
  "readOnly": {
    "adjustmentId": 1,
    "subType": 0,
    "relatedAdjustmentId": 1,
    "processDate": "2016-12-25T23:00:00",
    "referenceNum": "str",
    "poNumber": "str",
    "notes": "str",
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "warehouseTransactionSourceType": 0,
    "transactionEntryType": 0,
    "importChannelIdentifier": {
      "name": "str",
      "id": 2
    },
    "creationDate": "2016-12-25T23:00:00",
    "createdByIdentifier": {
      "name": "str",
      "id": 2
    },
    "lastModifiedDate": "2016-12-25T23:00:00",
    "lastModifiedByIdentifier": {
      "name": "str",
      "id": 2
    },
    "status": 0
  },
  "billing": {
    "billingCharges": [
      {
        "chargeType": 1,
        "subtotal": 1.0,
        "details": [
          {
            "warehouseTransactionPriceCalcId": 1,
            "numUnits": 2.0,
            "chargeLabel": "str",
            "unitDescription": "str",
            "chargePerUnit": 5.0,
            "glAcctNum": "str",
            "sku": "str",
            "ptItem": "str",
            "ptItemDescription": "str",
            "ptArAcct": "str",
            "systemGenerated": true,
            "taxCode": "str",
            "recurringChargeDetails": [
              {
                "recurringBillingDetailId": 1,
                "receiveItemId": 2,
                "onHandAtBillTime": 3.0,
                "itemIdentifier": {
                  "sku": "str",
                  "id": 2
                },
                "qualifier": "str",
                "lotNumber": "str",
                "serialNumber": "str",
                "expirationDate": "2016-12-25T23:00:00",
                "cost": 1.0,
                "supplierIdentifier": {
                  "name": "str",
                  "id": 2
                },
                "locationIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                },
                "palletIdentifier": {
                  "nameKey": {
                    "facilityIdentifier": {
                      "name": "str",
                      "id": 2
                    },
                    "name": "str"
                  },
                  "id": 1
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "savedElements": [
    {
      "name": "str",
      "value": "str"
    }
  ],
  "rowVersion": "str",
  "_embedded": {
    "item": [
      {
        "qty": 1.0,
        "readOnly": {
          "receiveItemId": 1,
          "fullyShippedDate": "2016-12-25T23:00:00",
          "unitIdentifier": {
            "name": "str",
            "id": 2
          },
          "secondaryUnitIdentifier": {
            "name": "str",
            "id": 2
          },
          "expectedQty": 1.0,
          "inventoryLevels": {
            "onHand": 1.0,
            "available": 2.0,
            "secondaryAvailable": 1.0
          },
          "onHoldDate": "2016-12-25T23:00:00",
          "onHoldUserIdentifier": {
            "name": "str",
            "id": 2
          },
          "facilityIdentifier": {
            "name": "str",
            "id": 2
          },
          "referenceNumber": "str",
          "transactionID": 3,
          "rowVersion": "str"
        },
        "itemIdentifier": {
          "sku": "str",
          "id": 2
        },
        "qualifier": "str",
        "externalId": "str",
        "secondaryQty": 1.0,
        "lotNumber": "str",
        "serialNumber": "str",
        "expirationDate": "2016-12-25T23:00:00",
        "cost": 1.0,
        "supplierIdentifier": {
          "name": "str",
          "id": 2
        },
        "locationInfo": {
          "locationId": 1,
          "display": "str",
          "rawField1": "str",
          "rawField2": "str",
          "rawField3": "str",
          "rawField4": "str"
        },
        "palletInfo": {
          "palletId": 1,
          "label": "str",
          "splitOverCapacityOnCreate": true,
          "qtyOverrideOnSplit": 1.0,
          "palletTypeIdentifier": {
            "name": "str",
            "id": 2
          },
          "metric": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          },
          "imperial": {
            "length": 1.0,
            "width": 1.0,
            "height": 1.0,
            "weight": 1.0
          }
        },
        "weightImperial": 1.0,
        "weightMetric": 1.0,
        "onHold": true,
        "onHoldReason": "str",
        "savedElements": [
          {
            "name": "str",
            "value": "str"
          }
        ],
        "condensedSEs": "str"
      }
    ]
  }
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.