payments_update
Update payment details within ServiceTitan, including transaction status, splits, and memo, using tenant ID and payment ID for precise modifications.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
id | Yes | Format - int64. | |
payload | No | Payment details to update | |
tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Format - int64.",
"type": "integer"
},
"payload": {
"additionalProperties": false,
"description": "Payment details to update",
"properties": {
"active": {
"type": "boolean"
},
"authCode": {
"type": "string"
},
"checkNumber": {
"type": "string"
},
"exportId": {
"type": "string"
},
"memo": {
"type": "string"
},
"paidOn": {
"type": "string"
},
"splits": {
"items": {
"additionalProperties": false,
"properties": {
"amount": {
"type": "number"
},
"invoiceId": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"status": {},
"transactionStatus": {},
"typeId": {
"type": "integer"
}
},
"type": "object"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"id",
"tenant"
],
"type": "object"
}