1. Shipments
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
          GET
        • List All Shipments
          GET
        • Retrieve Financials of Shipment
          GET
        • List Contacts of the Shipment
          GET
        • Create a Shipment
          POST
        • Update a Shipment
          PATCH
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Shipments

Retrieve Financials of Shipment

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/shipments/{id}/financials
Get financial of the Shipment.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required
ID of the Shipment
Example:
2165659

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/shipments/2165659/financials'

Responses

🟢200OK
application/json
Body
finload
array [object {11}] 
required
General financial information of the Shipment
invoiced_debit_local
number 
required
Total Invoiced Expenses
estimated_debit_local
number 
required
Total Pending Expenses
invoiced_credit_local
number 
required
Total Invoiced Revenue
estimated_credit_local
number 
required
Total Pending Revenue
relation_debit_local
number 
required
Total Shared Sales
relation_credit_local
number 
required
Total Shared Sales
invoiced_relation_debit_local
number 
required
Total Shared Invoiced Sales
invoiced_relation_credit_local
number 
required
Total Shared Invoiced Expenses
total_sales
number 
required
Total Profit
total_purchases
number 
required
Total Loss
profit_loss
number 
required
Profit&Loss
involines
array [object {24}] 
required
Line items included in the invoice
name
string 
required
Name of the invoice line item
finitem_id
integer 
required
Invoice Item ID
debit_credit
string 
required
Indicates whether the line item is a debit or credit
curr
string 
required
Currency of the line
curr_rate
number 
required
Exchange rate of the line currency
unit_number
number 
required
Number of units in the line item
unit_price
number 
required
Price per unit in the line item
total_amount
number 
required
Total amount of the line item
vat_rate
number 
required
VAT rate applied to the line item
vat_amount
number 
required
VAT amount for the line item
discount_rate
number 
required
Discount rate applied to the line item
discount_amount
number 
required
Discount amount for the line item
total_amount_local
number 
required
Total amount of the line item in local currency
total_amount_invoice
number 
required
Total amount of the line item in invoice currency
vat_amount_local
number 
required
VAT amount for the line item in local currency
vat_amount_invoice
number 
required
VAT amount for the line item in invoice currency
discount_amount_local
number 
required
Discount amount for the line item in local currency
discount_amount_invoice
number 
required
Discount amount for the line item in invoice currency
tax_er_code
string 
required
Tax code for the line item
tax_er
string 
required
Tax information for the line item
doc_no
string 
required
Document number associated with the line item
doc_date
string <date>
required
Date of the document associated with the line item
notes
string 
required
Additional notes for the line item
is_paid
boolean 
required
Indicates whether the invoice associated with this involine has been paid.
Example
{
    "finload": [
        {
            "invoiced_debit_local": 0,
            "estimated_debit_local": 0,
            "invoiced_credit_local": 0,
            "estimated_credit_local": 0,
            "relation_debit_local": 0,
            "relation_credit_local": 0,
            "invoiced_relation_debit_local": 0,
            "invoiced_relation_credit_local": 0,
            "total_sales": 0,
            "total_purchases": 0,
            "profit_loss": 0
        }
    ],
    "involines": [
        {
            "name": "string",
            "finitem_id": 0,
            "debit_credit": "string",
            "curr": "string",
            "curr_rate": 0,
            "unit_number": 0,
            "unit_price": 0,
            "total_amount": 0,
            "vat_rate": 0,
            "vat_amount": 0,
            "discount_rate": 0,
            "discount_amount": 0,
            "total_amount_local": 0,
            "total_amount_invoice": 0,
            "vat_amount_local": 0,
            "vat_amount_invoice": 0,
            "discount_amount_local": 0,
            "discount_amount_invoice": 0,
            "tax_er_code": "string",
            "tax_er": "string",
            "doc_no": "string",
            "doc_date": "2019-08-24",
            "notes": "string",
            "is_paid": true
        }
    ]
}
🟠403Forbidden
🟠404Record Not Found
🟠400Bad Request
Modified at 2025-04-21 07:25:48
Previous
List All Shipments
Next
List Contacts of the Shipment
Built with