line_item

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
id	string
object	string
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.
created_at	string
updated_at	string
itemizable_id	string	The ID of the payment order or expected payment.
itemizable_type	string	One of `payment_orders` or `expected_payments`.
amount	integer	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.
metadata	object	Additional data represented as key-value pairs. Both the key and value must be strings.
accounting	object
accounting_category_id	string	The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected.
accounting_ledger_class_id	string	The ID of one of the class objects in your accounting system. Class objects track segments of your business independent of client or project. Note that these will only be accessible if your accounting

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/line_item",
  "title": "line_item",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "itemizable_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the payment order or expected payment."
    },
    "itemizable_type": {
      "type": "string",
      "enum": [
        "ExpectedPayment",
        "PaymentOrder"
      ],
      "description": "One of `payment_orders` or `expected_payments`."
    },
    "amount": {
      "type": "integer",
      "description": "Value in specified currency's smallest unit. e.g. $10 would be represented as 1000."
    },
    "description": {
      "type": "string",
      "description": "A free-form description of the line item.",
      "nullable": true
    },
    "metadata": {
      "type": "object",
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      }
    },
    "accounting": {
      "$ref": "#/components/schemas/accounting"
    },
    "accounting_category_id": {
      "type": "string",
      "format": "uuid",
      "deprecated": true,
      "description": "The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected.",
      "nullable": true
    },
    "accounting_ledger_class_id": {
      "type": "string",
      "format": "uuid",
      "deprecated": true,
      "description": "The ID of one of the class objects in your accounting system. Class objects track segments of your business independent of client or project. Note that these will only be accessible if your accounting system has been connected.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "minProperties": 13,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "itemizable_id",
    "itemizable_type",
    "amount",
    "description",
    "metadata",
    "accounting",
    "accounting_category_id",
    "accounting_ledger_class_id"
  ]
}