Material Invoice

15 min

send material invoice details from your erp to transportone for each order this helps enable invoice validation, transporter billing, and smooth handover at the warehouse what is material invoice? a material invoice is the billing document for a shipment it includes details like the invoice number, amount, tax details, and e waybill information transportone uses this data to validate shipments, support warehouse gate clearance, and ensure accurate transporter billing info you should send this information before the vehicle leaves your facility overview once orders and loads are created, your erp system can send invoice level data for each order this step is usually completed before the load is dispatched from the origin facility the invoice includes billing value, e waybill details, and a reference to the associated order these details help transportone validate documentation and support warehouse gate clearance and transporter billing data flow before dispatch, your erp generates an invoice for an order (e g , ord123456 ) you use this api to send invoice details like invoice number, amount, e way bill, and tax info to transportone these are then available to warehouse staff and transporters at pickup typical flow erp generates invoice for a confirmed order api sends invoice details (amount, taxes, e waybill) to transportone tms stores the invoice for dock processing and transporter handover prerequisites before using this api, make sure you have a valid access token generated using the oauth client credentials flow the x coreos access key assigned to your tenant your tenantid to construct the correct base url (sandbox or production) \ \ https //docs1 getos1 com/authenticate with transportone base urls and endpoint base urls environment base url sandbox https //{tenantid} sandbox getos1 com production https //{tenantid} logistax io endpoint http post /api/v1/indents/action/actionuploadsupplierpod authentication & headers all requests must be authenticated using the transportone oauth 2 0 flow and must include the following headers required headers http ```http authorization bearer \<access token> x coreos access \<your access key> x coreos tid \<your tenant id> x coreos request id \<uuid> content type application/json follwowing fields are mandatory \header\ \description\ \required\ x coreos access coreos access token for authentication yes x coreos tid your assigned tenant id (organization identifier) yes x coreos request id unique uuid for each request (idempotency) this should be a uuid (e g , 123e4567 e89b 12d3 a456 426614174000) yes content type must be application/json yes x coreos userinfo optional user info token for audit trail optional x tms callback secre t secret key for verifying callbacks (base64 encoded) optional; required for webhook security \note \ fields marked with an asterisk are mandatory and must be included in every api request for successful authentication and processing endpoint http post /tms/api/v1/invoices/material base urls sandbox https //{tenantid} sandbox getos1 com/tms production https //{tenantid} logistax io/tms \note \ a postman collection with all transportone apis will be shared separately to help you test endpoints quickly request payload send this json body to create a material invoice all required fields must match the schema provided by the onboarding team { "loadid " "12345", "invoices" \[ { "invoicenumber" "inv123", "invoicedate" "2023 09 26", "invoiceamount" 1500 0, "invoicedescription" "product shipment", "ewaybill" "ewb123", "ewaybillexpdt" "2023 10 05", "irn" "irn123", "buyergst" "gstin123", "sellergst" "gstin456", "orders" \[ { "originfacility" "fac001", "destinationfacility" "fac002", "ordernumber" "ord123", "orderdt" "2023 09 25", "soldtofacility" "fac005", "lineitems" \[ { "lineitemnumber" "item001", "productcode" "prod001", "quantity" 100, "measurementunit" "kg", "weight" 500 0, "volume" 1 5, "weightunit" "kg", "volumeunit" "cft", "productmrp" 1000 0, "productcategory" "electronics" } ] } ] } ] } success response on successful submission, transportone will acknowledge the invoice data json { "success" true, "message" "invoice recorded" } field reference field type description invoicenumber string unique invoice number from erp ordernumber string associated order number for this invoice invoicedate string invoice issue date (yyyy mm dd) invoiceamount number net value of goods (excluding taxes) taxes object tax structure applied to this invoice totalamount number total invoice amount (invoicevalue + taxes) currency string currency code (e g , inr, usd) remarks string any notes, billing remarks, or internal references \note \ fields marked with an asterisk ( ) are required all other fields are optional view full attribute reference https //docs1 getos1 com/fields references#efemn what’s next? after submitting invoices, expect dispatch and vehicle events to flow to your erp via the load updates api track load status