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

Receive Notes/Lines

Download schema

GRN Line Items API.

GRN is used to received products in a purchase order or a stock transfer.

The GRN API is common for both purchase orders and stock transfers.

The URL param document_type is used to determine the type of document.

  • orders for purchase orders
  • stock-transfers for stock transfers

Conditions applicable to GRN Line Items

  • A maximum of 5000 Line items are allowed in a document.
  • Only products from the PO of the GRN can be added to the GRN.
  • A line item cannot have negative quantity.
  • A GRN cannot have duplicate products in its line items.

List GRN Lines

GET
https://inventory-api.sumtracker.com/api/version/2025-03
/purchases/{document_type}/{po_id}/grns/{grn_id}/lines/
Authorization (header)

List of GRN lines for a given GRN.

List GRN Lines › path Parameters

document_type
​string · pattern: ^orders|stock-transf… · required
grn_id
​integer · required
po_id
​integer · required

List GRN Lines › query Parameters

limit
​integer

Number of results to return per page.

o
​string[] · style: form

Ordering

  • id - Id
  • -id - Id (descending)
Enum values:
-id
id
offset
​integer

The initial index from which to return the results.

ordering
​string

Which field to use when ordering the results.

poline
​number

List GRN Lines › Responses

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

Create GRN Line

POST
https://inventory-api.sumtracker.com/api/version/2025-03
/purchases/{document_type}/{po_id}/grns/{grn_id}/lines/
Authorization (header)

Create a GRN line item.

Raises

  • ValidationError if the GRN is not in DRAFT status.

Create GRN Line › path Parameters

document_type
​string · pattern: ^orders|stock-transf… · required
grn_id
​integer · required
po_id
​integer · required

Create GRN Line › Request Body

Serializer used for listing the Grn instances and creating a new instance.
GrnLineCreate
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

Create GRN Line › Responses

Serializer used for listing the Grn instances and creating a new instance.
GrnLineCreate
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

Update GRN Line

PUT
https://inventory-api.sumtracker.com/api/version/2025-03
/purchases/{document_type}/{po_id}/grns/{grn_id}/lines/{id}/
Authorization (header)

Update a GRN line item.

Raises

  • ValidationError if the GRN is not in DRAFT status.

Update GRN Line › path Parameters

document_type
​string · pattern: ^orders|stock-transf… · required
grn_id
​integer · required
id
​integer · required
po_id
​integer · required

Update GRN Line › Request Body

Serializer used for retrieving, updating and deleting the Grn Instance.
GrnLineRUD
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

Update GRN Line › Responses

200
Serializer used for retrieving, updating and deleting the Grn Instance.
GrnLineRUD
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

Delete GRN Line

DELETE
https://inventory-api.sumtracker.com/api/version/2025-03
/purchases/{document_type}/{po_id}/grns/{grn_id}/lines/{id}/
Authorization (header)

Delete a GRN line item.

Raises

  • ValidationError if the GRN is not in DRAFT status.

Delete GRN Line › path Parameters

document_type
​string · pattern: ^orders|stock-transf… · required
grn_id
​integer · required
id
​integer · required
po_id
​integer · required

Delete GRN Line › Responses

No response body

No data returned
Received Notes (GRN)Stock Adjustment Documents