Documents

Manage documents and files associated with jobs, companies, or contacts. Includes invoices, bills of lading, photos, and other supporting documentation.

Quick Reference

Method	Endpoint	Description
GET	/api/documents/get/thumbnail/{docPath}
GET	/api/documents/get/{docPath}
GET	/api/documents/list
POST	/api/documents
PUT	/api/documents/update/{docId}
PUT	/api/documents/hide/{docId}

GET /api/documents/get/thumbnail/{docPath}

Parameters:

Path Parameters:

• docPath (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/documents/get/thumbnail/{docPath}"
,
    docPath="example-value"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

GET /api/documents/get/{docPath}

Parameters:

Path Parameters:

• docPath (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/documents/get/{docPath}"
,
    docPath="example-value"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

GET /api/documents/list

Parameters:

Query Parameters:

• jobDisplayId (string, query): No description available

• itemId (string, query): No description available

• rfqId (integer, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/documents/list"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

POST /api/documents

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/documents"

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

PUT /api/documents/update/{docId}

Parameters:

Path Parameters:

• docId (integer, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/documents/update/{docId}"
,
    docId=789e0123-e89b-12d3-a456-426614174002
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "updated",
  "message": "Resource updated successfully"
}

---

PUT /api/documents/hide/{docId}

Parameters:

Path Parameters:

• docId (integer, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/documents/hide/{docId}"
,
    docId=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "updated",
  "message": "Resource updated successfully"
}