customers charges (http://api.3plcentral.com/rels/customers/charges)
Resource:
ad hoc charge transaction
C# Rel Const:
Rels.CustomerSvc.Charges
URI template:
{id}/charges/{tid}
Obtain URI from:
get a charges list
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
tid * int transaction id
The embedded Billing collection contains WarehouseTransactionPriceCalcs associated with the transaction
Type Description
ReadOnly Customer.Models.ChargesReadOnly
TransactionId 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
RelatedTransactionId int? ...
ProcessDate DateTime? ...
ReferenceNum string
PONumber string
Notes string
Description 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
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": {
    "transactionId": 1,
    "subType": 0,
    "relatedTransactionId": 1,
    "processDate": "2016-12-25T23:00:00",
    "referenceNum": "str",
    "poNumber": "str",
    "notes": "str",
    "description": "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"
}

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.