Billing
Update Freight Invoice Payment Status
10 min
update the payment status of a freight invoice once your erp has processed the payment this ensures timely financial reconciliation in transportone once a freight invoice is paid in your erp, use this api to notify transportone include the invoice number, paid amount, date of payment, and transaction reference this keeps the tms invoice records in sync and reflects the correct payment status — whether fully or partially paid overview after your erp processes a payment for a freight invoice received from tms, use this api to notify transportone of the transaction this includes the payment id, applied amount, reference details (like utr or transaction id), and payment date this ensures transportone accurately reflects the paid or partially paid status of freight invoices, enabling better finance reconciliation when to use this after a freight invoice has been paid in your erp to update tms with the payment amount and reference to maintain real time alignment between erp and tms billing records data flow this api helps send data from your erp to transportone (tms) when a payment is made after your erp completes a payment — either full or partial — you call this api to notify tms about it you’ll send the invoice number, amount paid, and reference id (like a utr or transaction number) tms then marks that invoice as paid (or partially paid), so records stay in sync and there’s no duplicate chasing for payment your erp confirms to tms that the invoice is paid, so transportone updates its records accordingly prerequisites before calling this api, ensure your erp has successfully received the invoice from transportone you have a valid access token via the authentication flow you are using your assigned tenant specific base url each request includes a unique x coreos request id to ensure idempotency endpoint sandbox https //{tenantid} sandbox getos1 com/tms/api/v1/billing/payments production https //{tenantid} logistax io/tms/api/v1/billing/payments authentication & headers every request must include the following headers header name required description authorization yes bearer token obtained from the auth api x coreos access yes access key provided during onboarding x coreos tid yes your assigned tenant id x coreos request id yes unique uuid for each request (idempotency) content type yes must be application/json request payload send this json body to update a freight invoice payment status { "data" { "payments" \[ { "paymentid" "cqprpbik", "invoicenumber" "inv2025040403", "paymenttype" "cash", "totalamount" 208, "paymentdate" 1757116800000, "appliedamount" 208, "referencenumber" "utr123456" } ] }, "callback" { "url" "https //webhook site/your endpoint" } } required parameters below are the required parameters that must be included when sending payment updates field name type description sample value invoicenumber string unique identifier of the freight invoice inv2025040403 paymentid string unique transaction or reference id cqprpbik paymenttype string mode of payment (enum cash, dn) cash totalamount number total amount received for the payment (inr) 208 paymentdate number timestamp of payment date (ms epoch) 1757116800000 appliedamount number amount applied against the invoice (inr) 208 referencenumber string reference number (e g , utr, transaction id) utr123456 sample response { "success" true, "message" "payment recorded successfully" } what’s next? once the payment is recorded, the invoice status in tms is updated as paid or partially paid based on the amount applied you can view this in your billing reports or transport dashboard \[← back to billing overview]
