POST api/customerbill

Creates a Customer Bill record. A Customer record must exist in order to create a Customer Billing address.

Request Information

URI Parameters

None.

Body Parameters

CustomerBill
NameDescriptionTypeAdditional information
CustomerBillId

Sedona internal autonumber for the Customer Billing Address record

integer

None.

CustomerId

Foreign key from AR_Customer table

integer

Required

IsCommercial

True for Commercial account; false for Residential

boolean

Required

BillName

If a person, CustomerName should be passed in as "Last, First"

string

Required

String length: inclusive between 0 and 60

Address1

string

Required

String length: inclusive between 0 and 60

Address2

string

String length: inclusive between 0 and 60

Address3

string

String length: inclusive between 0 and 60

City

City name; must exist in the GE_Table1 table

string

Required

State

State 2 letter abbreviation; must exist in the GE_Table2 table

string

Required

Max length: 2

Zip

Zip code, not inclusive of extension (i.e. first 5 digits for U.S. zip); must exist in the GE_Table3 table

string

Required

County

County name; must exist in the GE_Table4 table

string

None.

ZipExt

Last 4 of zip code

string

String length: inclusive between 0 and 10

CountryAbbrev

Country code; must exist in the SS_Country table (Abbrev column); defaults to "USA" if not supplied

string

None.

Phone1

string

String length: inclusive between 0 and 25

Phone2

string

String length: inclusive between 0 and 25

Fax

string

String length: inclusive between 0 and 25

Email

string

String length: inclusive between 0 and 50

IsPrimary

Set to true if this is the primary billing address; this should be set to true for only one billing address

boolean

None.

Inactive

Set to true to make this bill address inactive

boolean

None.

BranchCode

Value from AR_Branch table; list of valid options can be retrieved from GET: api/branch

string

Required

String length: inclusive between 0 and 25

EmailInvoices

Send a copy of invoices via email; whether it is also printed/mailed is controlled at the Customer level

boolean

Required

BusinessName2

string

String length: inclusive between 0 and 60

Request Formats

application/json, text/json

Sample:
{
  "CustomerBillId": 1,
  "CustomerId": 2,
  "IsCommercial": true,
  "BillName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "Address3": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "Zip": "sample string 10",
  "County": "sample string 11",
  "ZipExt": "sample string 12",
  "CountryAbbrev": "sample string 13",
  "Phone1": "sample string 14",
  "Phone2": "sample string 15",
  "Fax": "sample string 16",
  "Email": "sample string 17",
  "IsPrimary": true,
  "Inactive": true,
  "BranchCode": "sample string 19",
  "EmailInvoices": true,
  "BusinessName2": "sample string 20"
}

application/xml, text/xml

Sample:
<CustomerBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <Address3>sample string 7</Address3>
  <BillName>sample string 4</BillName>
  <BranchCode>sample string 19</BranchCode>
  <BusinessName2>sample string 20</BusinessName2>
  <City>sample string 8</City>
  <CountryAbbrev>sample string 13</CountryAbbrev>
  <County>sample string 11</County>
  <CustomerBillId>1</CustomerBillId>
  <CustomerId>2</CustomerId>
  <Email>sample string 17</Email>
  <EmailInvoices>true</EmailInvoices>
  <Fax>sample string 16</Fax>
  <Inactive>true</Inactive>
  <IsCommercial>true</IsCommercial>
  <IsPrimary>true</IsPrimary>
  <Phone1>sample string 14</Phone1>
  <Phone2>sample string 15</Phone2>
  <State>sample string 9</State>
  <Zip>sample string 10</Zip>
  <ZipExt>sample string 12</ZipExt>
</CustomerBill>

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 'CustomerBill'.

Response Information

Resource Description

CustomerBill
NameDescriptionTypeAdditional information
CustomerBillId

Sedona internal autonumber for the Customer Billing Address record

integer

None.

CustomerId

Foreign key from AR_Customer table

integer

Required

IsCommercial

True for Commercial account; false for Residential

boolean

Required

BillName

If a person, CustomerName should be passed in as "Last, First"

string

Required

String length: inclusive between 0 and 60

Address1

string

Required

String length: inclusive between 0 and 60

Address2

string

String length: inclusive between 0 and 60

Address3

string

String length: inclusive between 0 and 60

City

City name; must exist in the GE_Table1 table

string

Required

State

State 2 letter abbreviation; must exist in the GE_Table2 table

string

Required

Max length: 2

Zip

Zip code, not inclusive of extension (i.e. first 5 digits for U.S. zip); must exist in the GE_Table3 table

string

Required

County

County name; must exist in the GE_Table4 table

string

None.

ZipExt

Last 4 of zip code

string

String length: inclusive between 0 and 10

CountryAbbrev

Country code; must exist in the SS_Country table (Abbrev column); defaults to "USA" if not supplied

string

None.

Phone1

string

String length: inclusive between 0 and 25

Phone2

string

String length: inclusive between 0 and 25

Fax

string

String length: inclusive between 0 and 25

Email

string

String length: inclusive between 0 and 50

IsPrimary

Set to true if this is the primary billing address; this should be set to true for only one billing address

boolean

None.

Inactive

Set to true to make this bill address inactive

boolean

None.

BranchCode

Value from AR_Branch table; list of valid options can be retrieved from GET: api/branch

string

Required

String length: inclusive between 0 and 25

EmailInvoices

Send a copy of invoices via email; whether it is also printed/mailed is controlled at the Customer level

boolean

Required

BusinessName2

string

String length: inclusive between 0 and 60

Response Formats

application/json, text/json

Sample:
{
  "CustomerBillId": 1,
  "CustomerId": 2,
  "IsCommercial": true,
  "BillName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "Address3": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "Zip": "sample string 10",
  "County": "sample string 11",
  "ZipExt": "sample string 12",
  "CountryAbbrev": "sample string 13",
  "Phone1": "sample string 14",
  "Phone2": "sample string 15",
  "Fax": "sample string 16",
  "Email": "sample string 17",
  "IsPrimary": true,
  "Inactive": true,
  "BranchCode": "sample string 19",
  "EmailInvoices": true,
  "BusinessName2": "sample string 20"
}

application/xml, text/xml

Sample:
<CustomerBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <Address3>sample string 7</Address3>
  <BillName>sample string 4</BillName>
  <BranchCode>sample string 19</BranchCode>
  <BusinessName2>sample string 20</BusinessName2>
  <City>sample string 8</City>
  <CountryAbbrev>sample string 13</CountryAbbrev>
  <County>sample string 11</County>
  <CustomerBillId>1</CustomerBillId>
  <CustomerId>2</CustomerId>
  <Email>sample string 17</Email>
  <EmailInvoices>true</EmailInvoices>
  <Fax>sample string 16</Fax>
  <Inactive>true</Inactive>
  <IsCommercial>true</IsCommercial>
  <IsPrimary>true</IsPrimary>
  <Phone1>sample string 14</Phone1>
  <Phone2>sample string 15</Phone2>
  <State>sample string 9</State>
  <Zip>sample string 10</Zip>
  <ZipExt>sample string 12</ZipExt>
</CustomerBill>