---
title: "API Availability"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28391092/API%20Availability"
format: markdown
---
# Overview

This page provides information on the current **API Availability**. This will include information about modules, API Functions, Method and other information.

> ✅ Refer to the [Frameworks Roadmap](https://sterkb.atlassian.net/wiki/pages/createpage.action?spaceKey=FRN&title=Frameworks%20Roadmap) and [Release Notes](https://sterlandsupport.atlassian.net/wiki/spaces/FRN) for more information on what is included in a particular release.

# API Availability 

Below is a list of Frameworks modules currently available API functions and their method and URI.

> ✅ Refer to the [Postman API Documentation](https://documenter.getpostman.com/view/873359/Uyxkijs6) for more detailed information about each API function.

##  Login

| **Method** | **URI** |
| --- | --- |
| <span style="color: #ff6600">POST</span> | /api/v1/login (form) |
| <span style="color: #ff6600">POST</span> | /api/v1/login (JSON) |
| <span style="color: #ff6600">POST</span> | /api/v1/session/validate |

## Branch

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | /api/v1/branch/list |
| <span style="color: #008000">GET</span> | /api/v1/branch/details |

## Company

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | /api/v1/company/list |
| <span style="color: #008000">GET</span> | /api/v1/company/details |

## Creditors (Payables)

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/creditors/invoice/list</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/creditors/invoice/details</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/creditors/receipt/list</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/creditors/receipt/details</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/creditors/invoice/create</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/creditors/invoice/update</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/creditors/invoice/delete</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/creditors/invoice/post</span> |
| <span style="color: #ff991f">POST</span> | /api/v1/creditors/expenseinvoice/create |

## Debtors (Receivables)

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | /api/v1/customer/list |
| <span style="color: #008000">GET</span> | /api/v1/customer/details |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/create |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/update |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/delete |
| <span style="color: #339966">GET</span> | /api/v1/customer/contact/list |
| <span style="color: #339966">GET</span> | /api/v1/customer/contact/details |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/contact/create |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/contact/update |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/contact/delete |
| <span style="color: #008000">GET</span> | /api/v1/customer/invoice/list |
| <span style="color: #008000">GET</span> | /api/v1/customer/invoice/detail |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/customer/invoice/email</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/customer/invoice/stream</span> |
| <span style="color: #008000">GET</span> | /api/v1/customer/statement/list |
| <span style="color: #008000">GET</span> | /api/v1/customer/statement/detail |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/customer/statement/email</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/customer/statement/stream</span> |
| <span style="color: #ff6600">POST</span> | /api/v1/customer/payment/create |
| <span style="color: #ff991f">POST</span> | /api/v1/customer/job/create |

## Inventory

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/location/list</span> |
| <span style="color: #008000">GET</span> | /api/v1/product/list |
| <span style="color: #008000">GET</span> | /api/v1/product/details<br>> ℹ️ As of v6.2.26R1.1, returns `marketCostOriginal` and `marketCostUom` in `keyDetails` when `InvUseProdCostingMth` is enabled. |
| <span style="color: #008000">GET</span> | /api/v1/product/branch/details<br>> ℹ️ As of v6.2.26R1.1, returns `marketCostOriginal` and `marketCostUom` in `branchPricing` when `InvUseProdCostingMth` is enabled. |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/product/location/list</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/stocktake/list</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/stocktake/details</span> |
| <span style="color: #ff6600">POST</span> | /api/v1/product/create |
| <span style="color: #ff6600">POST</span> | /api/v1/product/update |
| <span style="color: #ff6600">POST</span> | /api/v1/product/delete |
| <span style="color: #ff6600">POST</span> | /api/v1/product/branch/create |
| <span style="color: #ff6600">POST</span> | /api/v1/product/branch/update |
| <span style="color: #ff6600">POST</span> | /api/v1/product/branch/delete |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/stocktake/line/create</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/stocktake/line/update</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/stocktake/line/dele</span> |

## Purchase Order

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/purchaseorder/list</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/purchaseorder/details</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/purchaseorder/receipting</span> |

## Pick & Release

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/details</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/updatedetails</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/clearpick</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/pickall</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/completepick</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">api/v1/salesorder/pickrelease/reopenpick</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/checkpick</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/pickrelease/orderrelease</span> |

## Sales Order Processing

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | /api/v1/salesorder/list |
| <span style="color: #008000">GET</span> | /api/v1/salesorder/details |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/salesorder/despatchmethod/list</span> |
| <span style="color: #008000">GET</span> | <span style="color: #282828">/api/v1/salesorder/deliveryarea/list</span> |
| <span style="color: #ff6600">POST</span> | /api/v1/salesorder/productprice/details |
| <span style="color: #ff6600">POST</span> | /api/v1/salesorder/create |
| <span style="color: #ff6600">POST</span> | /api/v1/salesorder/update |
| <span style="color: #ff6600">POST</span> | /api/v1/salesorder/delete |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/acceptquote</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/email</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/stream</span> |
| <span style="color: #ff6600">POST</span> | /api<span style="color: #282828">/v1/salesorder/releaseorder</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/productiondetails/update</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/salesorder/productiondetails/componentcost</span> |

## Process Management

| **Method** | **URI** |
| --- | --- |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/processmanagement/task/update</span> |
| <span style="color: #ff6600">POST</span> | <span style="color: #282828">/api/v1/processmanagement/task/complete</span> |

# Planned API's

## Tasks

| **Method** | **URI** |
| --- | --- |
| <span style="color: #008000">GET</span> | TBA |
| <span style="color: #008000">GET</span> | TBA |
| <span style="color: #ff6600">POST</span> | TBA |
| <span style="color: #ff6600">POST</span> | TBA |
| <span style="color: #ff6600">POST</span> | TBA |
| <span style="color: #ff6600">POST</span> | TBA |

## Receivables

| **Method** | **URI** |
| --- | --- |
| POST | /api/v1/customer/adjustment/create |

# <span style="color: #003366">Additional Information</span>

> ✅ Refer to the [Postman API Documentation](https://documenter.getpostman.com/view/873359/Uyxkijs6) for more detailed information about each API function.