receipts_getlist

Retrieve and filter receipt data based on criteria like date, status, or custom fields in ServiceTitan, enabling precise data extraction and management for inventory and financial tracking.

Input Schema

Name	Required	Description
`active`	No	What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False]
`batchId`	No	Format - int64. BatchId filter
`billId`	No	Format - int64. BillId filter
`businessUnitIds`	No	Filter by a collection of business units
`createdBefore`	No	Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)
`createdOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)
`customFields.Fields`	No	Collection of custom field pairs (name, value) to filter by
`customFields.Operator`	No	Can be "Or" or "And" Values: [And, Or]
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`inventoryLocationIds`	No	Filter by a collection of inventory locations
`modifiedBefore`	No	Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)
`modifiedOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)
`number`	No	Number filter
`page`	No	Format - int32. The logical number of page to return, starting from 1
`pageSize`	No	Format - int32. How many records to return (50 by default)
`purchaseOrderIds`	No	Filter by a collection of purchase orders
`receivedBefore`	No	Format - date-time (as date-time in RFC3339). Return receipts with received date before certain date/time
`receivedOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return receipts with received date on or after certain date/time
`sort`	No	Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn.
`syncStatuses`	No	Filter by a collection of sync statuses
`tenant`	Yes	Format - int64. Tenant ID
`vendorIds`	No	Filter by a collection of vendors
`vendorInvoiceNumber`	No	Vendor invoice number filter

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "active": {
      "description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]",
      "type": [
        "string",
        "null"
      ]
    },
    "batchId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. BatchId filter"
    },
    "billId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. BillId filter"
    },
    "businessUnitIds": {
      "description": "Filter by a collection of business units",
      "type": [
        "string",
        "null"
      ]
    },
    "createdBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "createdOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "customFields.Fields": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Collection of custom field pairs (name, value) to filter by"
    },
    "customFields.Operator": {
      "description": "Can be \"Or\" or \"And\"\nValues: [And, Or]",
      "type": [
        "string",
        "null"
      ]
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": [
        "string",
        "null"
      ]
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": [
        "boolean",
        "null"
      ]
    },
    "inventoryLocationIds": {
      "description": "Filter by a collection of inventory locations",
      "type": [
        "string",
        "null"
      ]
    },
    "modifiedBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "modifiedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "number": {
      "description": "Number filter",
      "type": [
        "string",
        "null"
      ]
    },
    "page": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. The logical number of page to return, starting from 1"
    },
    "pageSize": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. How many records to return (50 by default)"
    },
    "purchaseOrderIds": {
      "description": "Filter by a collection of purchase orders",
      "type": [
        "string",
        "null"
      ]
    },
    "receivedBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return receipts with received date before certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "receivedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return receipts with received date on or after certain date/time",
      "type": [
        "string",
        "null"
      ]
    },
    "sort": {
      "description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, ModifiedOn, CreatedOn.",
      "type": [
        "string",
        "null"
      ]
    },
    "syncStatuses": {
      "description": "Filter by a collection of sync statuses",
      "type": [
        "string",
        "null"
      ]
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    },
    "vendorIds": {
      "description": "Filter by a collection of vendors",
      "type": [
        "string",
        "null"
      ]
    },
    "vendorInvoiceNumber": {
      "description": "Vendor invoice number filter",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

receipts_getlist

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools