Merge · Schema

PaymentLineItem

# The PaymentLineItem Object ### Description The `PaymentLineItem` object is an applied-to-line on a `Payment` that can either be a `Invoice`, `CreditNote`, or `JournalEntry`. ### Usage Example `Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
applied_amount	stringnull	The amount being applied to the transaction.
applied_date	stringnull	The date the payment portion is applied.
related_object_id	string	The Merge ID of the transaction the payment portion is being applied to.
related_object_type	string	The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentLineItem",
  "title": "PaymentLineItem",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "applied_amount": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The amount being applied to the transaction."
    },
    "applied_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The date the payment portion is applied."
    },
    "related_object_id": {
      "type": "string",
      "format": "uuid",
      "description": "The Merge ID of the transaction the payment portion is being applied to."
    },
    "related_object_type": {
      "type": "string",
      "description": "The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE."
    }
  },
  "description": "# The PaymentLineItem Object\n### Description\nThe `PaymentLineItem` object is an applied-to-line on a `Payment` that can either be a `Invoice`, `CreditNote`, or `JournalEntry`.\n\n### Usage Example\n`Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`."
}