List Payments
This endpoint returns a list of payments.
Endpoint: https://server/EventProApi/DataService.svc/payments
Method: GET
Refer to Payment Object and Payment Detail Object.
Sample Payments Response
Add Payment
This endpoint allows you to create a payment.
Endpoint: https://server/EventProApi/DataService.svc/payment/add
Method: POST
You pass to this endpoint a Payment Object with the required information.
Any non-Read-Only field you use will be updated on the payment record. NOTE: There are certain fields that you can write to during payment creation, but those fields become Read Only after the payment has been created.
If the Payment Object that you pass to this endpoint has Payment In Details, those Payment In Details will also be created.
The created payment is returned as a Payment Object.
Refer to Payment Object and Payment Detail Object.
For more details about whether an object needs to referenced by its Oid or ItemName, see Object Oid or ItemCode.
Update Payment
This endpoint allows you to make modifications to a payment.
Endpoint: https://server/EventProApi/DataService.svc/payment/update
Method: POST
You pass to this endpoint a Payment Object with the Oid set to the Oid of the payment you want to update.
Any non-Read-Only field you use will be updated on the payment record.
If the Payment Object that you pass to this endpoint has Payment In Details, those Payment In Details will also be updated. However, to Add Payment Details or Delete Payment Details, you must use the endpoints described below.
The updated payment is returned as a Payment Object.
Refer to Payment Object and Payment Detail Object.
For more details about whether an object needs to referenced by its Oid or ItemName, see Object Oid or ItemCode.
Add Payment Detail
This endpoint allows you to add a payment detail to an existing payment.
Endpoint: https://server/EventProApi/DataService.svc/payment/{paymentID}/details/add
Method: POST
This endpoint contains the ID of the Payment Object to which you want to add details.
You pass to this endpoint a Payment Detail Object with the required information.
Any non-Read-Only field you use will be updated on the payment detail record.
The updated payment is returned as a Payment Object.
Refer to Payment Object and Payment Detail Object.
For more details about whether an object needs to referenced by its Oid or ItemName, see Object Oid or ItemCode.
Delete Payment Detail
This endpoint allows you to remove a payment detail from an existing payment.
Endpoint: https://server/EventProApi/DataService.svc/payment/{paymentID}/details/delete/{paymentDetailID}
Method: GET
This endpoint contains the ID of the Payment Object from which you want to remove the detail.
The updated payment is returned as a Payment Object.
Refer to Payment Object and Payment Detail Object.
