A line_item is additional information that can be included on a payment order or an expected payment that represents a specific sub-amount. Line items will always sum to the total of the parent payment order or expected payment. Metadata is internal to Modern Treasury and will never be sent to your bank or be seen by your counterparties.
As an example, Company A is sending $100 to Company B to pay an invoice for two $50 widgets. Company A wants to track this information and creates a $100 Payment Order with two line items for $50 each and a unique description for each.
Attribute | Description |
|---|---|
id string | Unique identifier for the line item. |
amount int32 | Value in specified currency's smallest unit. e.g. $10 would be represented as 1000. |
description string | A free-form description of the line item. |
itemizable_id string | The ID of the payment order or expected payment. |
itemizable_type string | One of |
metadata object | Additional data represented as key-value pairs. Both the key and value must be strings. See . |
live_mode boolean | This field will be true if this object exists in the live environment or false if it exists in the test environment. |
{
"id": "ca12b3ec-884f-41f7-bde8-43e813dab5fa",
"amount": 20000,
"description": "Principal For Loan #123",
"itemizable_id": "ba450474-daa0-11ec-9d64-0242ac120002",
"itemizable_type": "payment_orders",
"metadata": {
"Type": "Principal"
},
"live_mode": true,
"created_at": "2019-11-09T00:11:07Z",
"updated_at": "2019-11-09T00:11:07Z"
}