InvoiceNumber Property

Invoice number if known or included in the package.

Syntax

 uspsshipintl.getInvoiceNumber([callback])
 uspsshipintl.setInvoiceNumber( invoiceNumber, [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 getInvoiceNumber([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 setInvoiceNumber([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

This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when PackageType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

The value of this property may be optionally sent in the GetFormCP72 method call.

Data Type

String