1. Financials
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
      • Invoice Items
        • List all Invoice Items
        • Deleted Invoice Items
      • Financials
        • Retrieve Financial Information
          GET
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • 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
      • Ens Declarations
        • Create an Ens Declaration
        • Download an Ens Declaration
    • 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
        • Get All Positions
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • 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
        • List Company Credit Limits
    • 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. Financials

Retrieve Financial Information

Testing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/financials
Retrieve financial information of multiple records or specific record.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Request Code 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/financials?parent_type=Logistics::Position&reference=POZ2410281&exclude_blanks=true&debit_credit=debit&page&per_page' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success
application/json
Body

Example
{
    "financials": [
        {
            "parent_type": "string",
            "parent_id": 0,
            "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,
            "invoiced_debit_usd": 0,
            "estimated_debit_usd": 0,
            "invoiced_credit_usd": 0,
            "estimated_credit_usd": 0,
            "relation_debit_usd": 0,
            "relation_credit_usd": 0,
            "invoiced_relation_debit_usd": 0,
            "invoiced_relation_credit_usd": 0,
            "invoiced_debit_eur": 0,
            "estimated_debit_eur": 0,
            "invoiced_credit_eur": 0,
            "estimated_credit_eur": 0,
            "relation_debit_eur": 0,
            "relation_credit_eur": 0,
            "invoiced_relation_debit_eur": 0,
            "invoiced_relation_credit_eur": 0,
            "total_sales": 0,
            "total_purchases": 0,
            "profit_loss": 0,
            "total_sales_usd": 0,
            "total_purchases_usd": 0,
            "profit_loss_usd": 0,
            "total_sales_eur": 0,
            "total_purchases_eur": 0,
            "profit_loss_eur": 0,
            "involines": [
                {
                    "id": 0,
                    "partner_company": "string",
                    "name": "string",
                    "created_at": "2019-08-24",
                    "parent_id": 0,
                    "parent_type": "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,
                    "tax_exclude_amount_invoice": "string",
                    "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,
                    "eur_curr_rate": 0,
                    "usd_curr_rate": 0,
                    "invoice_id": 0,
                    "invoice_name": "string",
                    "invoice_date": "2019-08-24",
                    "invoice_taxno": "string",
                    "invoice_tax_amount": 0,
                    "customer_account_no": "string",
                    "account_code": "string",
                    "invoice_status": "string",
                    "invoice_address": "string",
                    "finitem_report_group": "string",
                    "user_name": "string",
                    "finitem_name": "string",
                    "transport_details": {
                        "reference": "string",
                        "trans_mode": "string",
                        "pickup_date": "2019-08-24",
                        "delivery_date": "2019-08-24",
                        "etd": "2019-08-24T14:15:22.123Z",
                        "atd": "2019-08-24T14:15:22.123Z",
                        "eta": "2019-08-24T14:15:22.123Z",
                        "ata": "2019-08-24T14:15:22.123Z",
                        "mbl_no": "string",
                        "hbl_no": "string",
                        "departure_place": "string",
                        "arrival_place": "string",
                        "shipper": "string",
                        "consignee": "string",
                        "operator": "string",
                        "customer_ref": "string"
                    }
                }
            ]
        }
    ]
}
🟠403Forbidden
🟠404Record Not Found
🟠400Bad Request
🟠422Unprocessable Entity
Modified at 2025-12-31 11:40:52
Previous
Deleted Invoice Items
Next
List all NCTS Declarations
Built with