Billhighway Cloud API

<back to all web services

Company

The following routes are available for this service:
POST/company
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Company:
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    company_id: Optional[int] = None
    external_company_id: Optional[str] = None
    company_name: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip_code: Optional[str] = None
    country: Optional[str] = None
    website: Optional[str] = None
    phone_number: Optional[str] = None
    fax: Optional[str] = None
    state_id: Optional[int] = None
    country_id: Optional[int] = None
    chap_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReplyBase(IHaveErrorField):
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyReply(ReplyBase):
    unique_id: Optional[str] = None
    company_id: Optional[int] = None

Python 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
}