Skip to main content
GET
/
zapier
/
trigger
/
payment
Zapier Trigger for Payment Status Change
curl --request GET \
  --url http://127.0.0.1:5000/zapier/trigger/payment \
  --header 'Accept: <accept>'
{
  "id": 123,
  "description": "<string>",
  "status": "<string>",
  "amount": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "modifiedDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "initiatedPaymentDate": "2023-11-07T05:31:56Z",
  "paidDate": "2023-11-07T05:31:56Z",
  "clientFirstName": "<string>",
  "clientLastName": "<string>",
  "clientName": "<string>",
  "personId": 123,
  "proposalId": 123,
  "proposalNumber": 123,
  "number": 123,
  "paidVia": "<string>",
  "isEstExpired": true,
  "paymentProcessorType": "<string>",
  "proposalPaymentScheduleItemId": 123
}
This endpoint is used by the Portal.io Zapier integration. It fires when a payment’s status changes in your Portal.io account — for example, when a payment moves from Submitted to Paid, or from Paid to Refunded.

Headers

​
Accept
enum<string>
required

Accept Header

Available options:
application/json

Response

Payment Item.

ZapierPaymentItem

​
id
integer<int32>
​
description
string
​
status
string
​
amount
number<double>
​
createdDate
string<date-time>
​
modifiedDate
string<date-time>
​
dueDate
string<date-time>
​
initiatedPaymentDate
string<date-time>
​
paidDate
string<date-time>
​
clientFirstName
string
​
clientLastName
string
​
clientName
string
​
personId
integer<int32>
​
proposalId
integer<int32>
​
proposalNumber
integer<int32>
​
number
integer<int32>
​
paidVia
string
​
isEstExpired
boolean
​
paymentProcessorType
string
​
proposalPaymentScheduleItemId
integer<int32>