Sumtracker
Sumtracker Public API v2025-03
Sumtracker Public API v2025-03

Schemas

Download schema

Address

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.
id
​integer · readOnly · required
company_name
​string · maxLength: 100 · readOnly · required
first_name
​string · maxLength: 100 · readOnly · required
last_name
​string · maxLength: 100 · readOnly · required
phone
​string · maxLength: 100 · readOnly · required
​readOnly · required
tax_num
​string · maxLength: 20 · readOnly · required
address_line_1
​string · maxLength: 200 · readOnly · required
address_line_2
​string · maxLength: 100 · readOnly · required
city
​string · maxLength: 100 · readOnly · required
state
​string · maxLength: 100 · readOnly · required
pincode
​string · maxLength: 100 · readOnly · required
country
​string · maxLength: 100 · readOnly · required

AdjustmentTypeEnum

string · enum
Enum values:
SET
ADD
SUB
  • SET - SET
  • ADD - ADD
  • SUB - SUB

BundleLine

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.
id
​integer · readOnly · required
product_id
​integer · readOnly · required
component_id
​integer · readOnly · required
​object · readOnly · required

Product object.

quantity
​integer · min: 0 · max: 2147483647 · readOnly · required

Contact

Serializer for List of Suppliers.
id
​integer · readOnly · required
code
​string · maxLength: 50 · readOnly · required
first_name
​string · maxLength: 200 · readOnly · required
last_name
​string · maxLength: 200 · readOnly · required
company_name
​string · maxLength: 200 · readOnly · required
​readOnly · required
phone
​string · maxLength: 200 · readOnly · required
address_line_1
​string · maxLength: 200 · readOnly · required
address_line_2
​string · maxLength: 200 · readOnly · required
city
​string · maxLength: 100 · readOnly · required
state
​string · maxLength: 100 · readOnly · required
pincode
​string · maxLength: 100 · readOnly · required
country
​string · maxLength: 100 · readOnly · required
payment_terms
​string · maxLength: 1024 · readOnly · required
notes
​string · maxLength: 1024 · readOnly · required

Internal notes for the user's reference.

currency
​string · maxLength: 5 · readOnly · required

GrnCRUD

Serializer used for performing CRUD on a GRN.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
number
​string · readOnly · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · readOnly · required

The action performed on the document which initiated the task.

total_quantity
​integer · readOnly · required

Total sum of quantities from all associated lines within the document.

extra_charges
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
extra_shipping
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_shipping
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_amount
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
purchase_order_id
​integer · readOnly · required
is_stock_transfer
​boolean · readOnly · required
delivery_time
​string · date · readOnly · required
warehouse_id
​integer · required

If GRN is created for ST then:

  1. warehouse_id cannot be same as from_warehouse_id
  2. warehouse_id cannot be updated once GRN is created
status
​string · enum · readOnly · required

Current status: DRAFT (editable) → RECEIVED (stock updated) → FINAL (costs applied) or CANCELLED

  • DRAFT - DRAFT
  • RECEIVED - RECEIVED
  • FINAL - FINAL
  • CANCELLED - CANCELLED
Enum values:
DRAFT
RECEIVED
FINAL
CANCELLED
notes
​string
reference
​string · maxLength: 500

Optional reference number or notes for this GRN.

receive_by_time
​string | null · date-time

User defines the expected delivery time.

GrnLineCreate

Serializer used for listing the Grn instances and creating a new instance.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
quantity
​integer | null · readOnly · required
grn_id
​integer · readOnly · required
poline_id
​integer · required
is_stock_transfer
​boolean · readOnly · required
line_subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_total
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required

GrnLineRUD

Serializer used for retrieving, updating and deleting the Grn Instance.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
quantity
​integer · required

quantity in multiple of pack_size.

grn_id
​integer · readOnly · required
poline_id
​integer · readOnly · required
is_stock_transfer
​boolean · readOnly · required
line_subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_total
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required

PaginatedBundleLineList

count
​integer · required
​BundleLine[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedContactList

count
​integer · required
​Contact[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedGrnCRUDList

count
​integer · required
​GrnCRUD[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedGrnLineCreateList

count
​integer · required
​GrnLineCreate[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedPoLineList

count
​integer · required
​PoLine[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedProductList

count
​integer · required
​Product[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedPurchaseOrderListList

count
​integer · required
​PurchaseOrderList[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedStockAdjustmentDocumentLineList

count
​integer · required
​StockAdjustmentDocumentLine[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedStockAdjustmentDocumentList

count
​integer · required
​StockAdjustmentDocument[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedStockLevelBundleList

count
​integer · required
​StockLevelBundle[] · required
next
​string | null · uri
previous
​string | null · uri

PaginatedStockLevelList

count
​integer · required
​StockLevel[] · required
next
​string | null · uri
previous
​string | null · uri

PoLine

Serializer used for CRUD operations of POLine.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · required
​object · readOnly · required

Product object.

quantity
​integer | null · readOnly · required
purchase_order_id
​integer · readOnly · required
is_stock_transfer
​boolean · readOnly · required
tax_id
​integer | null · readOnly · required
delivered_quantity
​integer · readOnly · required
uom
​string · readOnly · required
pack_size
​integer · readOnly · required
supplier_sku
​string · readOnly · required
notes
​string · readOnly · required
tax_rate
​string · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
cost
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
shipping_cost
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
moq
​integer · readOnly · required
line_subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_total
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
error
​string | null · readOnly · required

Reason the line is not ready yet. Null when the line is fine. Blocks all document actions.

PoLineUpdate

Serializer for updating the POLine Instance.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

quantity
​integer · required

quantity in multiple of pack_size.

purchase_order_id
​integer · readOnly · required
is_stock_transfer
​boolean · readOnly · required
tax_id
​integer | null · readOnly · required
delivered_quantity
​integer · readOnly · required
uom
​string · readOnly · required
pack_size
​integer · readOnly · required
supplier_sku
​string · readOnly · required
tax_rate
​string · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required
moq
​integer · readOnly · required
line_subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
line_total
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
error
​string | null · readOnly · required

Reason the line is not ready yet. Null when the line is fine. Blocks all document actions.

notes
​string · maxLength: 200
cost
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…
shipping_cost
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Product

Product object.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
name
​string · maxLength: 200 · readOnly · required
sku
​string · maxLength: 200 · readOnly · required
variant_name
​string · maxLength: 200 · readOnly · required
barcode
​string · maxLength: 200 · readOnly · required
categories
​array | null · readOnly · required
​readOnly · required
notes
​string · maxLength: 500 · readOnly · required
bundle_type
​string · maxLength: 20 · readOnly · required
wavg_landed_cost
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
uom
​string · maxLength: 10 · readOnly · required

PurchaseOrderBase

Purchase Order Base Serializer used for creating, updating and retrieving the PO+ST instance.
warehouse_id
​integer · required
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · readOnly · required

The action performed on the document which initiated the task.

total_quantity
​integer · readOnly · required

Total sum of quantities from all associated lines within the document.

total_shipping
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_amount
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
status
​integer · readOnly · required
currency
​string · readOnly · required
conversion_rate
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
billing_address_id
​integer | null · readOnly · required
​object · readOnly · required

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.

shipping_address_id
​integer | null · readOnly · required
​object · readOnly · required

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.

contact_id
​integer

Required to create a purchase order

from_warehouse_id
​integer

Required to create a stock transfer

notes
​string
extra_charges
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…
extra_shipping
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…
confirmation_date
​string | null · date

Date the order was confirmed

ship_by_time
​string | null · date

Date by which the supplier is expected to ship the goods

expected_arrival_date
​string | null · date

Date the goods are expected to arrive at the warehouse

payment_terms
​string · maxLength: 200
reference
​string · maxLength: 500
shipping_carrier
​string · maxLength: 200
tracking_number
​string · maxLength: 200
​
number
​string · maxLength: 20

Must be unique per client and document type. Generated automatically when not provided. The automatic number sequence advances even when a number is provided.

PurchaseOrderList

Serializer used for getting the Purchase Orders List.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
contact_id
​integer · readOnly · required
warehouse_id
​integer · readOnly · required
from_warehouse_id
​integer · readOnly · required
number
​string · maxLength: 20 · readOnly · required
status
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
confirmation_date
​string | null · date · readOnly · required

Date of confirmed purchase order, when the po is marked incoming for the first time.

ship_by_time
​string | null · date · readOnly · required

Date by which the supplier is expected to ship the goods

expected_arrival_date
​string | null · date · readOnly · required

Date of expected arrival of goods

notes
​string · readOnly · required
reference
​string · maxLength: 500 · readOnly · required
total_amount
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_quantity
​integer · int64 · min: 0 · max: 9223372036854776000 · readOnly · required

Total sum of quantities from all associated lines within the document.

total_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_shipping
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · maxLength: 1024 · readOnly · required

The action performed on the document which initiated the task.

currency
​string · maxLength: 3 · readOnly · required
conversion_rate
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required

PurchaseOrderRUD

Serializer used for retrieving, updating or deleting the PO instance.
contact_id
​integer · readOnly · required
warehouse_id
​integer · readOnly · required
from_warehouse_id
​integer · readOnly · required
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · readOnly · required

The action performed on the document which initiated the task.

total_quantity
​integer · readOnly · required

Total sum of quantities from all associated lines within the document.

total_shipping
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_tax
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
total_amount
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
subtotal
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
status
​integer · readOnly · required
currency
​string · readOnly · required
conversion_rate
​string · decimal · readOnly · pattern: ^-?\d{0,10}(?:\.\d{0… · required
billing_address_id
​integer | null · readOnly · required
​object · readOnly · required

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.

shipping_address_id
​integer | null · readOnly · required
​object · readOnly · required

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.

notes
​string
extra_charges
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…
extra_shipping
​string · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…
confirmation_date
​string | null · date

Date the order was confirmed

ship_by_time
​string | null · date

Date by which the supplier is expected to ship the goods

expected_arrival_date
​string | null · date

Date the goods are expected to arrive at the warehouse

payment_terms
​string · maxLength: 200
reference
​string · maxLength: 500
shipping_carrier
​string · maxLength: 200
tracking_number
​string · maxLength: 200
​
number
​string · maxLength: 20

Not editable once the order is closed or cancelled. Must be unique per client and document type.

StatusEnum

string · enum
Enum values:
DRAFT
RECEIVED
FINAL
CANCELLED
  • DRAFT - DRAFT
  • RECEIVED - RECEIVED
  • FINAL - FINAL
  • CANCELLED - CANCELLED

StockAdjustmentDocument

StockAdjustmentDocument Serializer mixin
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
number
​string · readOnly · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · readOnly · required

The action performed on the document which initiated the task.

total_quantity
​integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type
​string · enum · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
reason
​string · maxLength: 1024 · required
warehouse_id
​integer · required
is_complete
​boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes
​string

StockAdjustmentDocumentLine

Mixin to inherit for stock adjustment document line serializers for update and create.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

StockAdjustmentDocumentLineUpdate

Adjust Stock Line Serializer used in Update case.
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

StockAdjustmentDocumentUpdate

StockAdjustmentDocument Serializer mixin
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
updated
​string · date-time · readOnly · required
number
​string · readOnly · required
is_task_in_progress
​boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed
​string · readOnly · required

The action performed on the document which initiated the task.

total_quantity
​integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type
​string · readOnly · required
reason
​string · readOnly · required
warehouse_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes
​string

StockAdjustmentLineCreate

id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · required
reason
​string · maxLength: 2048
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

StockLevel

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.
id
​integer · readOnly · required
updated
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

warehouse_id
​integer · readOnly · required
in_stock
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
incoming
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
close_at_quantity
​integer | null · min: -2147483648 · max: 2147483647 · readOnly · required

StockLevelBundle

Serializer for Bundle product stock level. It has components field which is a list of component stock levels.
id
​integer · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

warehouse_id
​integer · readOnly · required
in_stock
​integer · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
​_Component[] · readOnly · required

Tax

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.
id
​integer · readOnly · required
name
​string · maxLength: 50 · readOnly · required
tax_rate
​string · decimal · readOnly · pattern: ^-?\d{0,8}(?:\.\d{0,… · required

Warehouse

This serializer makes all fields read-only. It also sets the user's account timezone for the date time fields.
id
​integer · readOnly · required
name
​string · readOnly · required
code
​string · maxLength: 12 · readOnly · required
priority
​integer · min: 0 · max: 32767 · readOnly · required

_Component

Bundle component stock level serializer. Stock level serializer has a non-model field called component_quantity which is the quantity of the component in the bundle.
id
​integer · readOnly · required
​object · readOnly · required

Product object.

product_id
​integer · readOnly · required
warehouse_id
​integer · readOnly · required
in_stock
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
booked
​integer · min: -2147483648 · max: 2147483647 · readOnly · required
available
​integer · readOnly · required
component_quantity
​integer · readOnly · required
possible_bundles
​integer · readOnly · required
close_at_quantity
​integer | null · min: -2147483648 · max: 2147483647 · readOnly · required