Merge · Schema

VendorCreditLine

# The VendorCreditLine Object ### Description The `VendorCreditLine` object is used to represent a vendor credit's line items. ### Usage Example Fetch from the `GET VendorCredit` endpoint and view the vendor credit'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.
net_amount	numbernull	The full value of the credit.
tracking_category	stringnull	The line's associated tracking category.
tracking_categories	array	The vendor credit line item's associated tracking categories.
description	stringnull	The line's description.
account	stringnull	The line's account.
company	stringnull	The company the line belongs to.
project	stringnull
contact	stringnull
tax_rate	stringnull	The tax rate that applies to this line item.
exchange_rate	stringnull	The vendor credit line item's exchange rate.
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/VendorCreditLine",
  "title": "VendorCreditLine",
  "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."
    },
    "net_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The full value of the credit."
    },
    "tracking_category": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The line's associated tracking category."
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The vendor credit line item's associated tracking categories."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The line's description."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The line's account."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the line belongs to."
    },
    "project": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "tax_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The tax rate that applies to this line item."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The vendor credit line item's exchange rate."
    },
    "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 VendorCreditLine Object\n### Description\nThe `VendorCreditLine` object is used to represent a vendor credit's line items.\n\n### Usage Example\nFetch from the `GET VendorCredit` endpoint and view the vendor credit's line items."
}