A postal address captured for an invoice, quote or purchase order, such as a billing or delivery address. Typically built from the address fields of a shopping cart (see InvoicingService.generatePaymentAddress) and attached to a PaymentListBean as its billing or delivery address.
Properties
| Property | Returns | Description |
|---|---|---|
| addressLine1 | String | The first line of the street address. |
| addressLine2 | String | The second line of the street address, such as a unit or suite number. |
| addressState | String | The state or province of the address. |
| addressType | PaymentAddressType | The kind of address this is, such as a PO box, street or delivery address. |
| attentionTo | String | The name of the person the delivery or correspondence should be directed to. |
| city | String | The city or suburb of the address. |
| company | String | The company name associated with the address. |
| country | String | The country of the address. |
| notes | String | Free-text notes attached to the address, such as delivery instructions. |
| phone | String | A contact phone number for the address. |
| postcode | String | The postal or zip code of the address. |
Methods
getAddressType() · getAddressLine1() · getAddressLine2() · getCity() · getAddressState() · getCountry() · getPostcode() · getAttentionTo() · getNotes() · getPhone() · getCompany()
getAddressType()
Returns: PaymentAddressType
The kind of address this is, such as a PO box, street or delivery address.
getAddressLine1()
Returns: String
The first line of the street address.
getAddressLine2()
Returns: String
The second line of the street address, such as a unit or suite number.
getCity()
Returns: String
The city or suburb of the address.
getAddressState()
Returns: String
The state or province of the address.
getCountry()
Returns: String
The country of the address.
getPostcode()
Returns: String
The postal or zip code of the address.
getAttentionTo()
Returns: String
The name of the person the delivery or correspondence should be directed to.
getNotes()
Returns: String
Free-text notes attached to the address, such as delivery instructions.
getPhone()
Returns: String
A contact phone number for the address.
getCompany()
Returns: String
The company name associated with the address.