GET CommodityCustomerBalance/GetCommodityGrainBalance?CustID={CustID}&SplitOpenStorageOnHold={SplitOpenStorageOnHold}
Returns a list of Commodity Grain Balances.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
CustID |
CustID for the grain balances being requested. |
string |
Required |
SplitOpenStorageOnHold |
Splitout the open storage units from units that are on Hold |
boolean |
Default value is False |
Body Parameters
Response Information
Resource Description
Returns a list of Commodity Grain Balances.
AgvCommodityCustomerBalanceName | Description | Type | Additional Information |
---|---|---|---|
Status |
Status of the API call. |
string | |
Message |
Message of the API call. |
string | |
Count |
Count of how many Commodity JSON dictionaries. |
string | |
CustomerCommodityBalanceList |
JSON dictionary of Commodity balances. |
Collection of CustomerCommodityBalance |
Response Formats
application/json, text/json
Sample:
{ "Status": "sample string 1", "Message": "sample string 2", "Count": "sample string 3", "CustomerCommodityBalanceList": [ { "ColumnHeader": "sample string 1", "UnPaidPricedUnits": "sample string 2", "OpenStorage": "sample string 3", "PricedLater": "sample string 4", "GrainBank": "sample string 5", "WarehouseReceipt": "sample string 6", "FutureBased": "sample string 7", "InstallmentSales": "sample string 8", "DeferredPayment": "sample string 9", "Hold": "sample string 10", "AdditionalUnitBalances": [ { "UnitType": "sample string 1", "Units": "sample string 2", "UserDefinedLabel": "sample string 3" }, { "UnitType": "sample string 1", "Units": "sample string 2", "UserDefinedLabel": "sample string 3" } ] }, { "ColumnHeader": "sample string 1", "UnPaidPricedUnits": "sample string 2", "OpenStorage": "sample string 3", "PricedLater": "sample string 4", "GrainBank": "sample string 5", "WarehouseReceipt": "sample string 6", "FutureBased": "sample string 7", "InstallmentSales": "sample string 8", "DeferredPayment": "sample string 9", "Hold": "sample string 10", "AdditionalUnitBalances": [ { "UnitType": "sample string 1", "Units": "sample string 2", "UserDefinedLabel": "sample string 3" }, { "UnitType": "sample string 1", "Units": "sample string 2", "UserDefinedLabel": "sample string 3" } ] } ] }
application/xml, text/xml
Sample:
<AgvCommodityCustomerBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Commodity"> <Count>sample string 3</Count> <CustomerCommodityBalanceList> <CustomerCommodityBalance> <AdditionalUnitBalances> <AdditionalUnitTypes> <UnitType>sample string 1</UnitType> <Units>sample string 2</Units> <UserDefinedLabel>sample string 3</UserDefinedLabel> </AdditionalUnitTypes> <AdditionalUnitTypes> <UnitType>sample string 1</UnitType> <Units>sample string 2</Units> <UserDefinedLabel>sample string 3</UserDefinedLabel> </AdditionalUnitTypes> </AdditionalUnitBalances> <ColumnHeader>sample string 1</ColumnHeader> <DeferredPayment>sample string 9</DeferredPayment> <FutureBased>sample string 7</FutureBased> <GrainBank>sample string 5</GrainBank> <Hold>sample string 10</Hold> <InstallmentSales>sample string 8</InstallmentSales> <OpenStorage>sample string 3</OpenStorage> <PricedLater>sample string 4</PricedLater> <UnPaidPricedUnits>sample string 2</UnPaidPricedUnits> <WarehouseReceipt>sample string 6</WarehouseReceipt> </CustomerCommodityBalance> <CustomerCommodityBalance> <AdditionalUnitBalances> <AdditionalUnitTypes> <UnitType>sample string 1</UnitType> <Units>sample string 2</Units> <UserDefinedLabel>sample string 3</UserDefinedLabel> </AdditionalUnitTypes> <AdditionalUnitTypes> <UnitType>sample string 1</UnitType> <Units>sample string 2</Units> <UserDefinedLabel>sample string 3</UserDefinedLabel> </AdditionalUnitTypes> </AdditionalUnitBalances> <ColumnHeader>sample string 1</ColumnHeader> <DeferredPayment>sample string 9</DeferredPayment> <FutureBased>sample string 7</FutureBased> <GrainBank>sample string 5</GrainBank> <Hold>sample string 10</Hold> <InstallmentSales>sample string 8</InstallmentSales> <OpenStorage>sample string 3</OpenStorage> <PricedLater>sample string 4</PricedLater> <UnPaidPricedUnits>sample string 2</UnPaidPricedUnits> <WarehouseReceipt>sample string 6</WarehouseReceipt> </CustomerCommodityBalance> </CustomerCommodityBalanceList> <Message>sample string 2</Message> <Status>sample string 1</Status> </AgvCommodityCustomerBalance>