Overview

An Goods Receipt Note is a document that acknowledges the delivery of goods to a customer by a supplier

The Goods Receipt Notes Data Model is designed to standardise and simplify the handling of goods receipt notes related information across different accounting platforms.

• Unified goods receipt note properties: The model consolidates essential goods receipt note details, such as delivery date, currency, status, and total amounts, making it easier to manage invoice data from various platforms.
• Linked entities: Goods Receipt Notes can be associated with customers, line items, and purchase orders, providing a complete view of the invoicing 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.

Properties Supported

Property	Type	Description
platform_id	string	The Platform’s ID for the goods receipt note.
platform_unique_id	string	The unique ID generated by the platform for the goods receipt note.
description	string	A brief description of the goods receipt note.
sub_total	number	The total amount before applying discounts and taxes.
total_amount	number	The total amount after applying discounts and taxes.
total_discount	number	The total discount amount applied to the goods receipt note.
tax_amount	number	The total tax amount applied to the goods receipt note.
updated_at	string	The date and time when the goods receipt note was last updated.
payment_mode	string	The payment mode used for the goods receipt note.
delivery_date	string	The date when the goods were delivered to the customer.
purchase_order_ids	array	The IDs of the purchase orders associated with the goods receipt note.
currency_id	string	The ID of the currency used for the goods receipt note.
currency_rate	number	The exchange rate between the platform’s default currency and the currency used for the goods receipt note.
document_number	string	The document number of the goods receipt note.
posted_date	string	The date when the goods receipt note was posted.
status	string	The status of the goods receipt note. Possible values are DRAFT, SUBMITTED, PARTIALLY_PAID, PAID, and OVERDUE.
contact_id	string	The ID of the contact associated with the goods receipt note.

Expandable Attributes

You can expand the following attributes to get the related data

Property	Data Model	Description
contact	Contacts	The contact that made the invoice
currency	Currencies	The currency of the invoice
line_items	Line Item	The line items associated with the invoice

Line Items

Property	Type	Description
platform_id	string	Platform ID associated with this line item
item_id	string	The platform ID of the item associated with this line item
tax_id	string	The platform ID of the tax associated with this line item
account_id	string	The platform ID of the account associated with this line item
line_item_type	enum	The 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_id	string	The platform ID of the associated data model
description	string	The description for this line item
quantity	float	The quantity of the product/service for this line item
unit_amount	float	Price per unit for this line item
sub_total	float	The pre tax total value for this line item
tax_amount	float	The tax amount for this line item
total_amount	float	The total value of this line item
tracking_category_ids	object	The 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

Property	Data Model	Description
item	Items	The item associated with this line item
tax_rate	Tax Rates	The tax associated with this line item
account	Accounts	The account associated to the invoice

The Invoice Response Object

{
  "platform_id": "123456",
  "platform_unique_id": "123456",
  "description": "Goods Receipt Note",
  "sub_total": 100,
  "total_amount": 100,
  "total_discount": 0,
  "tax_amount": 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,
  "document_number": "123456",
  "posted_date": "2021-09-01T00:00:00Z",
  "status": "DRAFT",
  "contact_id": "123456"
}