> ## Documentation Index
> Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/api-reference/v3/accounting/contacts/overview)                        | The contact that made the invoice          |
| currency    | [Currencies](/api-reference/v3/accounting/currencies/overview)                    | The currency of the invoice                |
| line\_items | [Line Item](/api-reference/v3/accounting/goods-receipt-notes/overview#line-items) | The line items associated with the invoice |

<Snippet file="line_items_snippet.mdx" />

<ResponseExample name="The Invoice Object">
  ```json The Invoice Response Object theme={null}
  {
    "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"
  }
  ```
</ResponseExample>