Updated Invoice API

This commit is contained in:
Jay Patel
2016-09-19 14:32:33 -05:00
parent a1039ae38a
commit 4f20bc4b97
10 changed files with 209 additions and 11 deletions

View File

@@ -1190,7 +1190,7 @@ class Invoice extends PayPalResourceModel
}
/**
* Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Does not support partial updates.
* Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
@@ -1213,7 +1213,7 @@ class Invoice extends PayPalResourceModel
}
/**
* Deletes an invoice, by ID.
* Delete a particular invoice by passing the invoice ID to the request URI.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
@@ -1234,6 +1234,52 @@ class Invoice extends PayPalResourceModel
return true;
}
/**
* Delete external payment.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return bool
*/
public function deleteExternalPayment($transactionId, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($transactionId, "TransactionId");
$payLoad = "";
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/payment-records/{$transactionId}",
"DELETE",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* Delete external refund.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls
* @return bool
*/
public function deleteExternalRefund($transactionId, $apiContext = null, $restCall = null)
{
ArgumentValidator::validate($this->getId(), "Id");
ArgumentValidator::validate($transactionId, "TransactionId");
$payLoad = "";
self::executeCall(
"/v1/invoicing/invoices/{$this->getId()}/refund-records/{$transactionId}",
"DELETE",
$payLoad,
null,
$apiContext,
$restCall
);
return true;
}
/**
* Generate a QR code for an invoice by passing the invoice ID to the request URI. The request generates a QR code that is 500 pixels in width and height. You can change the dimensions of the returned code by specifying optional query parameters.
*
@@ -1269,7 +1315,7 @@ class Invoice extends PayPalResourceModel
}
/**
* Generate the successive invoice number for the merchant.
* Generates the successive invoice number.
*
* @param ApiContext $apiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
* @param PayPalRestCall $restCall is the Rest Call Service that is used to make rest calls