payments_get_list

payments_get_list

Retrieve and filter payment records from ServiceTitan by criteria such as date, customer ID, invoice status, and transaction type for efficient payment management.

Input Schema

Name	Required	Description
`appliedToInvoiceIds`	No
`appliedToReferenceNumber`	No
`batchId`	No	Format - int64.
`batchNumber`	No	Format - int32.
`businessUnitIds`	No
`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)
`customField.Fields`	No	Dictionary of name-value pairs
`customField.Operator`	No	Operator to be used between the name-value pairs. Can be "Or" or "And", default is "And". Values: [And, Or]
`customerId`	No	Format - int64.
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`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)
`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)
`paidOnAfter`	No	Format - date-time (as date-time in RFC3339).
`paidOnBefore`	No	Format - date-time (as date-time in RFC3339).
`sort`	No	Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order.
`statuses`	No
`tenant`	Yes	Format - int64. Tenant ID
`totalGreater`	No	Format - decimal.
`totalLess`	No	Format - decimal.
`transactionType`	No	Values: [Undefined, JournalEntry, ReceivePayment]

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "appliedToInvoiceIds": {
      "type": [
        "string",
        "null"
      ]
    },
    "appliedToReferenceNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "batchId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64."
    },
    "batchNumber": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32."
    },
    "businessUnitIds": {
      "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"
      ]
    },
    "customField.Fields": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "description": "Dictionary of name-value pairs"
    },
    "customField.Operator": {
      "description": "Operator to be used between the name-value pairs. Can be \"Or\" or \"And\", default is \"And\".\nValues: [And, Or]",
      "type": [
        "string",
        "null"
      ]
    },
    "customerId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64."
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": [
        "string",
        "null"
      ]
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": [
        "boolean",
        "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"
      ]
    },
    "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)"
    },
    "paidOnAfter": {
      "description": "Format - date-time (as date-time in RFC3339).",
      "type": [
        "string",
        "null"
      ]
    },
    "paidOnBefore": {
      "description": "Format - date-time (as date-time in RFC3339).",
      "type": [
        "string",
        "null"
      ]
    },
    "sort": {
      "description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.",
      "type": [
        "string",
        "null"
      ]
    },
    "statuses": {
      "type": [
        "string",
        "null"
      ]
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    },
    "totalGreater": {
      "description": "Format - decimal.",
      "type": [
        "number",
        "null"
      ]
    },
    "totalLess": {
      "description": "Format - decimal.",
      "type": [
        "number",
        "null"
      ]
    },
    "transactionType": {
      "description": "Values: [Undefined, JournalEntry, ReceivePayment]",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools