1. Periodic Documents
  • 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
        • 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
          GET
        • Update a Periodic Document
          PATCH
        • Create a Periodic Document
          POST
    • 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. Periodic Documents

Update a Periodic Document

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
PATCH
/api/v1/periodocs/{uuid}
Updates a Periodic Document by its UUID.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
uuid
string 
required
UUID of the periodic document
Example:
3e34e65c-608f-4c67-a2ab-d30cf9880290
Body Params application/json
periodoc
object 
required
periodoc_type_id
integer 
optional
ID of the periodic document type
doc_no
string 
optional
Document Number
doc_date
string <date>
optional
Document Date
start_date
string <date>
optional
Start date of the periodic document
due_date
string <date>
optional
Due date of the periodic document
title
string 
optional
Title of the periodic document
vehicle_id
integer 
optional
ID of the vehicle document issued
base64_image
string 
optional
A string containing the file's contents encoded in Base64 format. This can represent various file types, such as images, PDFs, or other documents.
Example
{
    "periodoc": {
      
    
        "doc_no": "ExampleDoc123"

    }
    
}

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 PATCH 'https://demo.modaltrans.com/api/v1/periodocs/3e34e65c-608f-4c67-a2ab-d30cf9880290' \
--header 'Content-Type: application/json' \
--data-raw '{
    "periodoc": {
      
    
        "doc_no": "ExampleDoc123"

    }
    
}'

Responses

🟢200Success
application/json
Body
uuid
string 
required
UUID of the periodic document
periodoc_type_id
integer 
required
ID of the periodic document type
doc_no
string 
required
Document Number
doc_date
string <date>
required
Document Date
start_date
string <date>
required
Start date of the document
due_date
string <date>
required
Due date of the document
status
string 
required
Status of the Document
periodoc_type_name
string 
required
Name of the periodic document type
Example
{
    "uuid": "string",
    "periodoc_type_id": 0,
    "doc_no": "string",
    "doc_date": "2019-08-24",
    "start_date": "2019-08-24",
    "due_date": "2019-08-24",
    "status": "string",
    "periodoc_type_name": "string"
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-29 12:19:27
Previous
Retrieve a Periodic Document
Next
Create a Periodic Document
Built with