PaymentDate Property
Contains the date on which the invoice was paid.
Syntax
invoice.getPaymentDate([callback]) invoice.setPaymentDate( paymentDate, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getPaymentDate([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setPaymentDate([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Contains the date on which the invoice was paid.
The date and time must be in the following format:
"yyyy-MM-ddTHH:mm:ss.fffZ".
This is explained in more detail below:
yyyy | Four-digit year, e.g. "2005" |
MM | Two-digit month. |
dd | Two-digit day. |
T | Indicates time follows the date. |
HH | Hours in military time (24-hour format). |
mm | Minutes |
ss | Seconds |
fff | Milliseconds |
Z | 1-character (US military) representation of the time zone, "A" - "M" are negative offsets -1 to -12, with "J" not being used. "N" - "Y" are positive offsets 1 to 12, and "Z" indicates GMT/UTC (no offset). |
For instance, "2004-05-26T15:00:00.000Z" is May 26th, 2004 at 3:00pm GMT.
Data Type
String