Fields References

material invoice payload parameters and description following are the fields and description along with the data type that will be used for updating material invoice in the tms(os1) system field name field name type type description description sample value sample value r r equired loadid string unique identifier for the load 12345 yes invoices array of objects list of invoice entries yes invoices invoicenumber string invoice number inv123 yes invoices invoicedt string (date) invoice date 2023 09 26 yes invoices invoiceamount number total invoice value (inr) 1500 yes invoices invoicedescription string description or remarks related to the invoice/shipment product shipment yes invoices ewaybill string e way bill number ewb123 no invoices ewaybillexpdt string (date) e way bill expiry date 2023 10 05 no invoices irn string invoice reference number (irn) irn123 no invoices buyergst string gst number of the buyer gstin123 no invoices sellergst string gst number of the seller gstin456 no invoices orders array of objects list of orders associated with the invoice yes invoices orders originfacility string origin facility code for the order fac001 yes invoices orders destinationfacility string destination facility code fac002 yes invoices orders ordernumber string unique order identifier ord123 yes invoices orders orderdt string (date) order date 2023 09 25 yes invoices orders soldtofacility string facility to which the order is sold fac005 no invoices orders lineitems array line items within the order yes invoices orders lineitems lineitemnumber string unique identifier for the line item item001 yes invoices orders lineitems productcode string code of the product prod001 yes invoices orders lineitems quantity integer quantity of the product 100 yes invoices orders lineitems measurementunit string unit of measurement pcs no invoices orders lineitems weight number weight of the product 500 no invoices orders lineitems volume number volume occupied by the product 1 5 no invoices orders lineitems weightunit string unit used for weight kg no invoices orders lineitems volumeunit string unit used for volume cft no invoices orders lineitems productmrp number maximum retail price of the product 1000 no invoices orders lineitems productcategory string product category or classification electronics no approved fright invoice field reference approved freight invoice field name type description sample value invoicenumber string unique invoice number inv2025040403 transporterid string unique transporter id sin295 irn string invoice reference number (can be empty) "" billingaddress object contains billing entity details billingaddress billto gstnumber string gst number of the bill recipient 09aaach7409r1zz billingaddress billto address string billing address of the recipient 301 chaitanya billingaddress billby gstnumber string gst number of the issuer (transporter) 06aapcs9575e1zr billingaddress billby address string address of the issuing party gurgaon patheria 1 supportingdocs array list of additional document urls \[] pretaxamount number pre tax invoice amount declared by transporter (inr) 800 pretaxsystemamount number system calculated pre tax amount (inr) 200 duedate integer (epoch) invoice due date 1753381800000 approvalstate string current approval level of the invoice l2 transporterremark string remarks by the transporter "" transporterinvoicedocs array of strings urls of supporting invoice documents \["https // manifest pdf"] systeminvoicepdf string system generated invoice pdf url https //yourdomain com/ /invoice 12345 pdf paidamount number amount paid till now (inr) 0 submittedat integer (epoch) timestamp of invoice submission 1743758164499 submittedby string name of the person submitting the invoice saurabh singh loadcount integer number of loads covered by the invoice 1 differenceamount number amount difference between declared and system amounts 672 invoicedate integer (epoch) date of invoice issue 1743705000000 taxamount number tax amount declared by the transporter (inr) 96 taxsystemamount number system calculated tax amount (inr) 24 totalamount number total declared amount including tax (inr) 896 totalsystemamount number system calculated total amount (inr) 224 transportertaxamountbreakup object breakup of tax declared by transporter {"igst" {"rate" 12, "amount" 96}} systemtaxamountbreakup object system's tax breakup {"igst" {"rate" 12, "amount" 24}} transportername string name of the transporter singh transporters indents array of objects details of loads covered under the invoice indents indentid string indent identifier rn2fh5 indents contractid string associated contract id rvvhwg 1 indents origin string origin of the indent midc indents destination string destination of the indent j101 indents stops, orderids, invoiceids arrays lists of stops, orders, and invoice ids (optional) \[] indents lrs array of strings lr numbers associated with the indent \["lr02", "lr01"] indents routenamedetails object facility names for route indents routenamedetails originfacility string origin facility name mumbai midc indents routenamedetails destinationfacility string destination facility name jaunpur enterprise indents expenses number declared expenses by transporter (inr) 800 indents expensesdiff number system difference on expenses (inr) 600 indents deductions number deductions declared (inr) 0 indents deductionsdiff number system calculated deduction variance (inr) 0 indents charges array of objects list of charges applied indents charges chargehead string type of charge applied (e g , otherexpense) otherexpense indents charges chargetype string type of entry (expense/deduction) expense indents charges systemamount number system calculated amount (inr) 0 indents charges amount number amount declared by transporter (inr) 600 indents charges transporterremarks string remarks for the charge extra labour has to be used indents charges supportingdocs array supporting documents for the charge \[] note note fields listed above are sent from tms to erp mandatory fields for implementation should be validated during integration testing