UpdateInvoiceStatus (Push Method)
UpdateInvoiceStatus
Updates the status of one or more invoices in Invision.
Supports setting payment details when the target status is Payment Received.
Request
| Parameter | Type | Description |
|---|---|---|
| Company | String | Required. Company identifier from GetCompanies. |
| InvoiceNumber | String | Required. One or more invoice numbers (comma‑separated supported by some clients, e.g., "1080, UPC137175"). |
| Status | String | Required. Target status to apply. Possible values include: Paid; Ready for Payment; Approved; Pending; Awaiting Payment; Rejected. |
| Comments | String | Required. Comment describing the status change. |
| CheckNo | String | Required if Status = Payment Received, otherwise leave blank. |
| CheckDate | String | Required if Status = Payment Received, otherwise leave blank. |
| CheckAmount | String | Required if Status = Payment Received, otherwise leave blank. |
Response
| Parameter | Type | Description |
|---|---|---|
| ID | String | Identifier in BAP. |
| Status | String | Current status in BAP after the update. |
| Errors | Array | Contains error message(s) should an error occur. |
Example (C#)
// setup request parameters
ParametersForUpdateInvoiceStatus objUpdateInvoiceStatus = new ParametersForUpdateInvoiceStatus
{
Company = "ABC",
InvoiceNumber = "1080, UPC137175", // Multiple invoices supported by some client wrappers
Status = "Rejected",
Comments = "Set invoice to pending again due to more testing.",
CheckNo = "", // supply only if Status = "Payment Received"
CheckDate = "", // supply only if Status = "Payment Received"
CheckAmount = "" // supply only if Status = "Payment Received"
};
dynamic UpdateInvoiceStatus = apiClient.UpdateInvoiceStatus(objUpdateInvoiceStatus);
Console.WriteLine("Status :" + UpdateInvoiceStatus);