Merge · Schema

CreditNoteLineItemRequest

# 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
remote_id	stringnull	The third-party API ID of the matching object.
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
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreditNoteLineItemRequest",
  "title": "CreditNoteLineItemRequest",
  "type": "object",
  "properties": {
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "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"
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "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."
}