Billhighway Cloud API

InvoiceCollection

The following routes are available for this service:
POST	/invoices/misc

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 InvoiceReply:
    unique_id: Optional[str] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    inv_batch_no: Optional[int] = None
    inv_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceCollectionReply(IHaveErrorField):
    invoice_reply: Optional[List[InvoiceReply]] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceItem(IInvoiceItemValidation):
    unique_id: Optional[str] = None
    product_name: Optional[str] = None
    amount_due: Optional[Decimal] = None
    product_type: Optional[str] = None
    act_pattern_type_i_d: Optional[int] = None
    term_start_date: Optional[datetime.datetime] = None
    term_end_date: Optional[datetime.datetime] = None
    recognition_period: Optional[int] = None
    revenue_account: Optional[str] = None
    accounts_receivable_account: Optional[str] = None
    liability_account: Optional[str] = None
    credit_expense_account: Optional[str] = None
    invoice_clearing_account: Optional[str] = None
    cost_center: Optional[str] = None
    region: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Invoice(IInvoiceValidation):
    unique_id: Optional[str] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    description: Optional[str] = None
    opportunity_id: Optional[str] = None
    installments: Optional[int] = None
    frequency: Optional[int] = None
    invoice_due_date: Optional[datetime.datetime] = None
    deliver: Optional[bool] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    currency_type: Optional[str] = None
    invoice_items: Optional[List[InvoiceItem]] = None
    invoice_no: Optional[int] = None
    invoice_amt: Optional[Decimal] = None
    external_inv_batch_no: Optional[str] = None
    exempt_from_late_fee: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceCollection:
    invoice_list: Optional[List[Invoice]] = None

Python InvoiceCollection 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 /invoices/misc HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InvoiceList: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			OpportunityId: String,
			InvoiceDueDate: 0001-01-01,
			Installments: 0,
			Frequency: 0,
			BhUserId: 0,
			Description: String,
			Deliver: False,
			CurrencyType: String,
			InvoiceItems: 
			[
				{
					ProductName: String,
					AmountDue: String,
					RevenueAccount: String
				}
			],
			InvoiceNo: 0,
			InvoiceAmt: 0,
			ExternalInvBatchNo: String,
			ExemptFromLateFee: False
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	InvoiceReply: 
	[
		{
			UniqueId: String,
			ErrorCode: 0,
			ErrorMessage: String,
			InvBatchNo: 0,
			InvAmount: 0
		}
	],
	IsError: False
}