Skip to main content
The Goods Receipt Notes Data Model represents a document that acknowledges the delivery of goods to a customer by a supplier. This unified model standardizes and simplifies the handling of goods receipt notes related information across different accounting platforms.
  • Unified goods receipt note properties: Essential goods receipt note details, such as delivery date, currency, status, and total amounts, are standardized across different accounting platforms
  • Linked entities: Goods Receipt Notes can be associated with contacts, line items, and purchase orders, providing a complete view of the goods receipt process and related transactions
  • Flexible status tracking: The model supports a range of goods receipt note statuses, such as draft, submitted, partially paid, and overdue, for better organisation and reporting

​
Attributes

​
Goods Receipt Note Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier assigned by Commenda for this goods receipt note
rootfi_created_atstringTimestamp when this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringTimestamp when this record was last updated in Commenda’s system (ISO 8601)
rootfi_company_idintegerCompany identifier this goods receipt note belongs to within Commenda
platform_idstringUnique identifier for this goods receipt note in the source accounting platform
platform_unique_idstringAlternative unique identifier from the platform (some platforms provide multiple IDs)
contact_idstringThe contact ID of the goods receipt note
currency_idstringThe currency ID of the goods receipt note
descriptionstringThe description of the goods receipt note
sub_totaldoubleThe sub total of the goods receipt note
total_amountdoubleThe total amount of the goods receipt note
total_discountdoubleThe total discount of the goods receipt note
tax_amountdoubleThe tax amount of the goods receipt note
updated_atstringThe date and time the goods receipt note was last updated
payment_modestringThe payment mode of the goods receipt note
delivery_datestringThe delivery date of the goods receipt note
purchase_order_idsarrayThe purchase order IDs associated with the goods receipt note
currency_ratedoubleThe currency rate of the goods receipt note
document_numberstringThe document number of the goods receipt note
posted_datestringThe posted date of the goods receipt note
statusenumThe status of the goods receipt note
line_itemsarrayThe line items of the goods receipt note

​
Status Enum Values

ValueDescription
draftGoods receipt note is in draft status and has not been finalized
submittedGoods receipt note has been submitted but not yet paid
partially_paidGoods receipt note has received partial payment
paidGoods receipt note has been fully paid
overdueGoods receipt note has passed its due date without payment
voidGoods receipt note has been voided or cancelled
unknownStatus cannot be determined from the platform

​
Expandable Attributes

Use the expand query parameter to include related objects:
  • expand=contact - Includes full Contact object details
  • expand=currency - Includes full Currency object details
  • expand=line_items - Includes detailed LineItem objects

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the goods receipt note
platform_unique_idstringThe unique ID generated by the platform for the goods receipt note
descriptionstringThe description of the goods receipt note
sub_totaldoubleThe sub total of the goods receipt note
total_amountdoubleThe total amount of the goods receipt note
total_discountdoubleThe total discount of the goods receipt note
tax_amountdoubleThe tax amount of the goods receipt note
updated_atstringThe date and time the goods receipt note was last updated
payment_modestringThe payment mode of the goods receipt note
delivery_datestringThe delivery date of the goods receipt note
purchase_order_idsarrayThe purchase order IDs associated with the goods receipt note
currency_idstringThe currency ID of the goods receipt note
currency_ratedoubleThe currency rate of the goods receipt note
document_numberstringThe document number of the goods receipt note
posted_datestringThe posted date of the goods receipt note
statusenumThe status of the goods receipt note
contact_idstringThe contact ID of the goods receipt note
line_itemsarrayThe line items of the goods receipt note

​
Line Items

PropertyTypeDescription
platform_idstringPlatform ID associated with this line item
item_idstringThe platform ID of the item associated with this line item
tax_idstringThe platform ID of the tax associated with this line item
account_idstringThe platform ID of the account associated with this line item
line_item_typeenumThe data model linked to the line item. Values are: BILLS, INVOICES, INVOICE_CREDIT_NOTES, BILL_CREDIT_NOTES, EXPENSES, PURCHASE_ORDERS,SALES_ORDERS,GOODS_RECEIPT_NOTES
line_item_type_idstringThe platform ID of the associated data model
descriptionstringThe description for this line item
quantityfloatThe quantity of the product/service for this line item
unit_amountfloatPrice per unit for this line item
sub_totalfloatThe pre tax total value for this line item
tax_amountfloatThe tax amount for this line item
total_amountfloatThe total value of this line item
tracking_category_idsobjectThe tracking category Ids associated with this line item

​
Line Items Expandable Attributes

You can expand the following attributes to get the related line item data
PropertyData ModelDescription
itemItemsThe item associated with this line item
tax_rateTax RatesThe tax associated with this line item
accountAccountsThe account associated to the invoice
{
  "rootfi_id": 123,
  "rootfi_created_at": "2024-01-25T09:00:00Z",
  "rootfi_updated_at": "2024-01-25T09:00:00Z",
  "rootfi_company_id": 456,
  "platform_id": "123456_1",
  "platform_unique_id": "123456",
  "description": "Goods Receipt Note",
  "sub_total": 100.0,
  "total_amount": 100.0,
  "total_discount": 0.0,
  "tax_amount": 0.0,
  "updated_at": "2021-09-01T00:00:00Z",
  "payment_mode": "Cash",
  "delivery_date": "2021-09-01T00:00:00Z",
  "purchase_order_ids": ["123456"],
  "currency_id": "123456",
  "currency_rate": 1.0,
  "document_number": "123456",
  "posted_date": "2021-09-01T00:00:00Z",
  "status": "draft",
  "contact_id": "123456",
  "line_items": []
}