Merge · Schema

InvoiceLineItemRequest

# The InvoiceLineItem Object ### Description The `InvoiceLineItem` object represents an itemized record of goods and/or services sold to a customer. ### Usage Example Fetch from the `GET Invoice` endpoint and view the invoice's line items.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
remote_id	stringnull	The third-party API ID of the matching object.
description	stringnull	The line item's description.
unit_price	numbernull	The line item's unit price.
quantity	numbernull	The line item's quantity.
total_amount	numbernull	The line item's total amount.
employee	stringnull	The employee this overall transaction relates to.
project	stringnull
contact	stringnull	The invoice's contact.
currency	object	The line item's currency. The currency code in ISO 4217 format.
exchange_rate	stringnull	The line item's exchange rate.
item	stringnull
account	stringnull
tax_rate	stringnull	The tax rate that applies to this line item.
tracking_category	stringnull
tracking_categories	array	The invoice line item's associated tracking categories.
company	stringnull	The company the invoice belongs to.
is_billable	booleannull	Indicates if the line item can be charged to the client/customer.
integration_params	objectnull
linked_account_params	objectnull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InvoiceLineItemRequest",
  "title": "InvoiceLineItemRequest",
  "type": "object",
  "properties": {
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The line item's description."
    },
    "unit_price": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The line item's unit price."
    },
    "quantity": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The line item's quantity."
    },
    "total_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The line item's total amount."
    },
    "employee": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The employee this overall transaction relates to."
    },
    "project": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The invoice's contact."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The line item's currency. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The line item's exchange rate."
    },
    "item": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The tax rate that applies to this line item."
    },
    "tracking_category": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The invoice line item's associated tracking categories."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the invoice belongs to."
    },
    "is_billable": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Indicates if the line item can be charged to the client/customer."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The InvoiceLineItem Object\n### Description\nThe `InvoiceLineItem` object represents an itemized record of goods and/or services sold to a customer.\n\n### Usage Example\nFetch from the `GET Invoice` endpoint and view the invoice's line items."
}