Billhighway Cloud API

<back to all web services

Company

The following routes are available for this service:
POST/company

export class Company
{
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public CompanyId?: number;
    public ExternalCompanyId?: string;
    public CompanyName?: string;
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public State?: string;
    public ZipCode?: string;
    public Country?: string;
    public Website?: string;
    public PhoneNumber?: string;
    public Fax?: string;
    public StateId?: number;
    public CountryId?: number;
    public ChapId?: number;

    public constructor(init?: Partial<Company>) { (Object as any).assign(this, init); }
}

export class ReplyBase implements IHaveErrorField
{
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<ReplyBase>) { (Object as any).assign(this, init); }
}

export class CompanyReply extends ReplyBase
{
    public UniqueId?: string;
    public CompanyId?: number;

    public constructor(init?: Partial<CompanyReply>) { super(init); (Object as any).assign(this, init); }
}

TypeScript Company DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /company HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	GroupId: String,
	CompanyId: 0,
	ExternalCompanyId: String,
	CompanyName: String,
	Address1: String,
	Address2: String,
	City: String,
	State: String,
	ZipCode: String,
	Country: String,
	Website: String,
	PhoneNumber: String,
	Fax: String,
	StateId: 0,
	CountryId: 0,
	ChapId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CompanyId: 0,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False
}