Merge · Schema

ExpenseRequest

# The Expense Object ### Description The `Expense` object is used to represent a direct purchase by a business, typically made with a check, credit card, or cash. Each `Expense` object is dedicated to a grouping of expenses, with each expense recorded in the lines object. The `Expense` object is also used to represent refunds to direct purchases. Refunds can be distinguished from purchases by the amount sign of the records. Expense objects with a negative amount are purchases and `Expense` objects with a positive amount are refunds to those purchases. ### Usage Example Fetch from the `GET Expense` endpoint and view a company's expense.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
transaction_date	stringnull	When the transaction occurred.
account	stringnull	The expense's payment account.
contact	stringnull	The expense's contact.
total_amount	numbernull	The expense's total amount.
sub_total	numbernull	The expense's total amount before tax.
total_tax_amount	numbernull	The expense's total tax amount.
currency	object	The expense's currency. The currency code in ISO 4217 format.
exchange_rate	stringnull	The expense'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 expense belongs to.
employee	stringnull	The employee this overall transaction relates to.
memo	stringnull	The expense's private note.
lines	array
tracking_categories	array
accounting_period	stringnull	The accounting period that the Expense was generated in.
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/ExpenseRequest",
  "title": "ExpenseRequest",
  "type": "object",
  "properties": {
    "transaction_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the transaction occurred."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The expense's payment account."
    },
    "contact": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The expense's contact."
    },
    "total_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The expense's total amount."
    },
    "sub_total": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The expense's total amount before tax."
    },
    "total_tax_amount": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The expense's total tax amount."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The expense's currency. The currency code in ISO 4217 format."
    },
    "exchange_rate": {
      "type": [
        "string",
        "null"
      ],
      "format": "decimal",
      "description": "The expense'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 expense belongs to."
    },
    "employee": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The employee this overall transaction relates to."
    },
    "memo": {
      "type": [
        "string",
        "null"
      ],
      "description": "The expense's private note."
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExpenseLineRequest"
      }
    },
    "tracking_categories": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "accounting_period": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The accounting period that the Expense was generated in."
    },
    "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 Expense Object\n### Description\nThe `Expense` object is used to represent a direct purchase by a business, typically made with a check, credit card, or cash. Each `Expense` object is dedicated to a grouping of expenses, with each expense recorded in the lines object.\n\nThe `Expense` object is also used to represent refunds to direct purchases. Refunds can be distinguished from purchases by the amount sign of the records. Expense objects with a negative amount are purchases and `Expense` objects with a positive amount are refunds to those purchases.\n\n### Usage Example\nFetch from the `GET Expense` endpoint and view a company's expense."
}