Consignment

Kind: Object

A delivery challan: goods sent to a retailer unpaid.

Fields

Field	Type	Description
id	ID!
number	String!	Challan number, e.g. RFDC/2627/00001.
status	ConsignmentStatus!
unitCount	Int!
unitsOutstanding	Int!	Units still to be accounted for: neither accepted nor refused. Do not derive it as unitCount minus the lines’ quantityAccepted and quantityRejected: a unit lost in transit is settled without changing those counters.
totalValuePaise	Int!	GST-inclusive value of the goods, at transfer price.
totalTaxablePaise	Int!
placeOfSupply	String!
transportMode	TransportMode!
vehicleNumber	String!
ewayBillNumber	String!
dispatchedAt	DateTime
acknowledgedAt	DateTime
forceAcknowledged	Boolean!	True when staff closed the receipt for the dealer.
note	String!
lines	[ConsignmentLine!]!
challanUrl	String	The printable Rule 55 challan, in triplicate. Served from our storage: absolute when object storage is configured, otherwise a path relative to the API origin — resolve it before use. Expires, so fetch it fresh rather than storing it.
kind	ConsignmentKind!	OUTBOUND for goods going out, INBOUND_RETURN for goods coming home.
originChallanNumber	String!	On a return challan, the outward challan it reverses. Rule 55 wants the original named on the document.
originChallanDate	Date
dealerId	ID	The retailer this consignment is for. Names are not unique; ids are.
dealerName	String!