Merge · Schema

VendorCredit

# The VendorCredit Object ### Description A `VendorCredit` is transaction issued by a vendor to the accounting company, indicating a reduction or cancellation of the amount owed to the vendor. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a purchasing transaction. A `VendorCredit` can be applied to `Accounts Payable` Invoices to decrease the overall amount of the `Invoice`. ### Usage Example Fetch from the `GET VendorCredit` endpoint and view a company's vendor credits.

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.
number	stringnull	The vendor credit's number.
transaction_date	stringnull	The vendor credit's transaction date.
vendor	stringnull	The vendor that owes the gift or refund.
total_amount	numbernull	The vendor credit's total amount.
currency	object	The vendor credit's currency. The currency code in ISO 4217 format.
exchange_rate	stringnull	The vendor credit's exchange rate.
inclusive_of_tax	booleannull	If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive.
company	stringnull	The company the vendor credit belongs to.
lines	array
tracking_categories	array
applied_to_lines	array	A list of VendorCredit Applied to Lines objects.
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
accounting_period	stringnull	The accounting period that the VendorCredit was generated in.
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VendorCredit",
  "title": "VendorCredit",
  "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."
    },
    "number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The vendor credit's number."
    },
    "transaction_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The vendor credit's transaction date."
    },
    "vendor": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The vendor that owes the gift or refund."
    },
    "total_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The vendor credit's total amount."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The vendor credit's currency. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The vendor credit's exchange rate."
    },
    "inclusive_of_tax": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the vendor credit belongs to."
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VendorCreditLine"
      }
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "applied_to_lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VendorCreditApplyLineForVendorCredit"
      },
      "description": "A list of VendorCredit Applied to Lines objects."
    },
    "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/)."
    },
    "accounting_period": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The accounting period that the VendorCredit was generated in."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/VendorCreditFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The VendorCredit Object\n### Description\nA `VendorCredit` is transaction issued by a vendor to the accounting company, indicating a reduction or cancellation of the amount owed to the vendor. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a purchasing transaction. A `VendorCredit` can be applied to `Accounts Payable` Invoices to decrease the overall amount of the `Invoice`.\n\n### Usage Example\nFetch from the `GET VendorCredit` endpoint and view a company's vendor credits."
}