POST v1/Customer/CustomerPostageAccountList

Returns the list of postage accounts for a customer

Request Information

URI Parameters

None.

Body Parameters

CustomerPostageAccountListRequest
NameDescriptionTypeAdditional information
PostageAccountID

PostageAccountID

 integer

None.
CustomerID

CustomerID

 integer

Required
AccountNumber

AccountNumber

 string

None.
Active

Active

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "PostageAccountID": 1,
  "CustomerID": 1,
  "AccountNumber": "sample string 2",
  "Active": true
}

application/xml, text/xml

Sample: 
<CustomerPostageAccountListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PostageAccountID>1</PostageAccountID>
  <CustomerID>1</CustomerID>
  <AccountNumber>sample string 2</AccountNumber>
  <Active>true</Active>
</CustomerPostageAccountListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerPostageAccountListRequest'.

Response Information

Resource Description

Collection of CustomerPostageAccountListResponse
NameDescriptionTypeAdditional information
Description

Description

 string

None.
Balance

Balance

 decimal number

None.
CreditAmount

CreditAmount

 decimal number

None.
PostageAccountID

PostageAccountID

 integer

None.
CustomerID

CustomerID

 integer

Required
AccountNumber

AccountNumber

 string

None.
Active

Active

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PostageAccountID": 1,
    "CustomerID": 4,
    "AccountNumber": "sample string 5",
    "Description": "sample string 1",
    "Balance": 2.0,
    "CreditAmount": 3.0,
    "Active": true
  },
  {
    "PostageAccountID": 1,
    "CustomerID": 4,
    "AccountNumber": "sample string 5",
    "Description": "sample string 1",
    "Balance": 2.0,
    "CreditAmount": 3.0,
    "Active": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerPostageAccountListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerPostageAccountListResponse>
    <PostageAccountID>1</PostageAccountID>
    <CustomerID>4</CustomerID>
    <AccountNumber>sample string 5</AccountNumber>
    <Active>true</Active>
    <Description>sample string 1</Description>
    <Balance>2</Balance>
    <CreditAmount>3</CreditAmount>
  </CustomerPostageAccountListResponse>
  <CustomerPostageAccountListResponse>
    <PostageAccountID>1</PostageAccountID>
    <CustomerID>4</CustomerID>
    <AccountNumber>sample string 5</AccountNumber>
    <Active>true</Active>
    <Description>sample string 1</Description>
    <Balance>2</Balance>
    <CreditAmount>3</CreditAmount>
  </CustomerPostageAccountListResponse>
</ArrayOfCustomerPostageAccountListResponse>