Merge · Schema

CreditNoteLineItem

# The CreditNoteLineItem Object ### Description The `CreditNoteLineItem` object is used to represent a credit note's line items. ### Usage Example Fetch from the `GET CreditNote` endpoint and view the credit note's line items.

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.
item	stringnull
name	stringnull	The credit note line item's name.
description	stringnull	The description of the item that is owed.
quantity	stringnull	The credit note line item's quantity.
memo	stringnull	The credit note line item's memo.
unit_price	stringnull	The credit note line item's unit price.
tax_rate	stringnull	The tax rate that applies to this line item.
total_line_amount	stringnull	The credit note line item's total.
tracking_category	stringnull	The credit note line item's associated tracking category.
tracking_categories	array	The credit note line item's associated tracking categories.
account	stringnull	The credit note line item's account.
company	stringnull	The company the credit note belongs to.
contact	stringnull	The credit note's contact.
project	stringnull
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreditNoteLineItem",
  "title": "CreditNoteLineItem",
  "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."
    },
    "item": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The credit note line item's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the item that is owed."
    },
    "quantity": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The credit note line item's quantity."
    },
    "memo": {
      "type": [
        "string",
        "null"
      ],
      "description": "The credit note line item's memo."
    },
    "unit_price": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The credit note line item's unit price."
    },
    "tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The tax rate that applies to this line item."
    },
    "total_line_amount": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The credit note line item's total."
    },
    "tracking_category": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The credit note line item's associated tracking category."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The credit note line item's associated tracking categories."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The credit note line item's account."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the credit note belongs to."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The credit note's contact."
    },
    "project": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    }
  },
  "description": "# The CreditNoteLineItem Object\n### Description\nThe `CreditNoteLineItem` object is used to represent a credit note's line items.\n\n### Usage Example\nFetch from the `GET CreditNote` endpoint and view the credit note's line items."
}