ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.GetPaymentsForInvoice Method

Get the list of payments that have been made against an invoice. 

Specify the ID of the invoice to get the payments for. The payments are returned in a list of TPayment objects. 

The list will contain all payments that affect the invoice in any way. The Amount in each TPayment will be the amount of the payment that was disbursed to the invoice in question - this may not be the full payment amount, if the payment was recorded against multiple invoices. 

A token is passed for authentication. If the authentication fails, or other errors occur, the employers are not returned. The result of the authentication is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Finance feature. 

This function has security level "Protected", and can only be accessed by users that have explicitly been granted permission to the API.

C#
[WebMethod(Description = "Gets the payments that have been recorded against an invoice")]
public TAuthPaymentList GetPaymentsForInvoice(string token, int invoiceId);
Parameters 
Description 
string token 
String containing a token. 
int invoiceId 
Integer ID of invoice to get payments for. 

TAuthPaymentList : an Authenticated list of payments.

Copyright (c) VETtrak 2022. All rights reserved.