CustomerPaymentHandler

This class contains the functions to perform the following:

Retrieve:

  • Customer Invoice Payment(s)
Update:
  • Customer Invoice Payment Flag

api
package simPROAPI
subpackage Invoice
author Nathan Muir, Michael West
version 2011-07-18

 Methods

CustomerPaymentInsert

Insert(int $CompanyID, array $PaymentDetails, array $Invoices) : int
Static
<?php
$PaymentDetails =
      array(
          "Notes"=>"",
          "Date"=>"Y-m-d",
          "PaymentInfo"=>"",
          "DepositAccount"=>"",
          "PaymentMethod"=>""
      );
"Invoices" =
   array(
        1000 => 500.00, 1001 => 250.25
   );
?>

Parameters

$CompanyID

int

the company id

$PaymentDetails

array

an associative array of payment information.

$Invoices

array

Returns

int

CustomerPaymentRetrieve

Retrieve(int $CompanyID, mixed $PaymentNo) : array
Static

This function retrieves a payment with a particular id.

uses \CustomerInvoiceHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PaymentNo

mixed

The payment no with/with-out the CR prefix

Returns

array

CustomerPaymentRetrieveAll

RetrieveAll(int $CompanyID, array $PaymentIDs) : array
StaticNot Implemented

This function searches for the list of Customer invoice payments within a date range, or for all time if the date ranges are omitted.

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PaymentIDs

array

The list of payment Ids

Returns

array

CustomerPaymentRetrieveList

RetrieveList(int $CompanyID, array $PaymentNos) : array
Static

This function searches for the list of Customer invoice payments within a date range, or for all time if the date ranges are omitted.

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$PaymentNos

array

The list of payment nos

Returns

array

CustomerPaymentSearchInvoice

SearchInvoice(int $CompanyID, int $InvoiceNo) : array
StaticNot Implemented

Finds all payments for a particular invoice no.

uses \CustomerInvoiceHandler::RetrieveList()

Parameters

$CompanyID

int

the Company ID. In single company builds, this is 0.

$InvoiceNo

int

the Invoice to find the particular payments for

Returns

array