1. Invoices
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
          GET
        • List all Invoices
          GET
    • 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
        • 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
    • 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. Invoices

Retrieve an Invoice

Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/invoices/{trancation_id}
Retrieves the details of a invoice by its transaction ID.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
trancation_id
integer 
required
Transaction ID of the invoice
Example:
3283836

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/invoices/3283836'

Responses

🟢200OK
application/json
Body
uuid
string 
required
UUID of the invoice
name
string 
required
Name of the invoice
invoice_date
string <date>
required
Date when the invoice was issued
due_date
string <date>
required
Date when the invoice is due
debit_credit
string 
required
Indicates whether the invoice is a debit or credit
invoice_title
string 
required
Title of the invoice
invoice_taxno
string 
required
Tax number associated with the invoice
invoice_taxoffice
string 
required
Tax office associated with the invoice
invoice_address
string 
required
Address of the invoice
work_type
string 
required
Type of the invoice
invoice_amount
number 
required
Total amount of the invoice
taxfree_amount
number 
required
Amount of the invoice that is tax-free
taxed_amount
number 
required
Amount of the invoice that is taxed
tax_amount
number 
required
Total tax amount of the invoice
curr
string 
required
Currency of the invoice amount
curr_rate
number 
required
Exchange rate of the currency
status
string 
required
Current status of the invoice
einvoice_status
string 
required
Status of the e-invoice
einvoice_postbox
string 
required
E-invoice postbox information
einvoice_notes
string 
required
Additional notes for the e-invoice
branchCode
string 
required
Code of the branch issuing the invoice
branchName
string 
required
Name of the branch issuing the invoice
invoiceLines
array [object {23}] 
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
invoiceNotes
array[string]
required
Example
{
    "uuid": "string",
    "name": "string",
    "invoice_date": "2019-08-24",
    "due_date": "2019-08-24",
    "debit_credit": "string",
    "invoice_title": "string",
    "invoice_taxno": "string",
    "invoice_taxoffice": "string",
    "invoice_address": "string",
    "work_type": "string",
    "invoice_amount": 0,
    "taxfree_amount": 0,
    "taxed_amount": 0,
    "tax_amount": 0,
    "curr": "string",
    "curr_rate": 0,
    "status": "string",
    "einvoice_status": "string",
    "einvoice_postbox": "string",
    "einvoice_notes": "string",
    "branchCode": "string",
    "branchName": "string",
    "invoiceLines": [
        {
            "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"
        }
    ],
    "invoiceNotes": [
        "string"
    ]
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-03-25 10:47:50
Previous
Get Bearer Token
Next
List all Invoices
Built with