GET
/
v1
/
cogs_entries
/
list
curl --location --request GET 'https://api.stateset.com/v1/cogs_entries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

{
  "id": 123,
  "period": "<string>",
  "product": "<string>",
  "quantity_sold": 123,
  "cogs": 123,
  "average_cost": 123,
  "ending_inventory_quantity": 123,
  "ending_inventory_value": 123,
  "currency": "<string>",
  "exchange_rate_id": 123,
  "sale_transaction_id": 123,
  "unit_selling_price": 123,
  "gross_sales": 123,
  "gross_profit": 123,
  "gross_margin_percentage": 123,
  "cogs_percentage": 123,
  "cogs_method": "<string>",
  "product_category": "<string>",
  "sales_channel": "<string>",
  "customer_segment": "<string>",
  "sale_date": "<string>",
  "is_return": true,
  "return_reason": "<string>",
  "cost_center": "<string>",
  "supplier_id": 123
}

​
Body

​
limit
string
required
This is the limit of the COGS entries to return.
​
offset
string
required
This is the offset of the COGS entries.
​
order_direction
string
required
This is the order direction of the COGS entries.

​
Response

​
id
integer
Unique identifier for the COGS entry (primary key)
​
period
string
The accounting period for the COGS entry
​
product
string
The product associated with the COGS entry
​
quantity_sold
integer
The quantity of the product sold
​
cogs
number
The Cost of Goods Sold amount
​
average_cost
number
The average cost per unit
​
ending_inventory_quantity
number
The quantity of inventory remaining at the end of the period
​
ending_inventory_value
number
The value of the ending inventory
​
currency
string
The currency used for the financial calculations
​
exchange_rate_id
integer
Identifier for the related exchange rate
​
sale_transaction_id
integer
Identifier for the related sale transaction
​
unit_selling_price
number
The selling price per unit
​
gross_sales
number
The total gross sales amount
​
gross_profit
number
The gross profit amount
​
gross_margin_percentage
number
The gross margin percentage
​
cogs_percentage
number
The COGS as a percentage of sales
​
cogs_method
string
The method used to calculate COGS
​
product_category
string
The category of the product
​
sales_channel
string
The channel through which the sale was made
​
customer_segment
string
The segment of the customer who made the purchase
​
sale_date
string
The date of the sale
​
is_return
boolean
Indicates whether this entry is for a return
​
return_reason
string
The reason for the return, if applicable
​
cost_center
string
The cost center associated with the COGS entry
​
supplier_id
integer
Identifier for the related supplier
curl --location --request GET 'https://api.stateset.com/v1/cogs_entries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'


query ($limit: Int!, $offset: Int!, $order_direction: order_by) {
  cogs_entries(limit: $limit, offset: $offset, order_by: {id: $order_direction}) {
    id
    period
    product
    quantity_sold
    cogs
    average_cost
    ending_inventory_quantity
    ending_inventory_value
    currency
    exchange_rate_id
    sale_transaction_id
    unit_selling_price
    gross_sales
    gross_profit
    gross_margin_percentage
    cogs_percentage
    cogs_method
    product_category
    sales_channel
    customer_segment
    sale_date
    is_return
    return_reason
    cost_center
    supplier_id
  }
}