Billhighway Cloud API

<back to all web services

SalesForceInvoiceCollection

The following routes are available for this service:
POST/api/SalesForce/InvoiceCollection

export class SalesForceInvoiceReply
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public InvBatchNo?: number;
    public InvAmount?: number;

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

export class SalesForceInvoiceCollectionReply implements IHaveErrorField
{
    public InvoiceReply?: SalesForceInvoiceReply[];
    public IsError?: boolean;

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

export class SalesForceInvoiceItem
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public ProductName?: string;
    public AmountDue?: string;
    public ProductType?: string;
    public ActPatternTypeId?: number;
    public TermStartDate?: string;
    public TermEndDate?: string;
    public RecognitionPeriod?: number;
    public RevenueAccount?: string;
    public AccountsReceivableAccount?: string;
    public LiabilityAccount?: string;
    public CreditExpenseAccount?: string;
    public InvoiceClearingAccount?: string;
    public CostCenter?: string;
    public Region?: string;

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

export class SalesForceInvoice
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public OpportunityId?: string;
    public InvoiceDueDate?: string;
    public Installments?: number;
    public Frequency?: number;
    public BhUserId?: number;
    public Description?: string;
    public Deliver?: boolean;
    public CurrencyType?: string;
    public InvoiceItems?: SalesForceInvoiceItem[];
    public InvoiceNo?: number;
    public InvoiceAmt?: number;
    public ExternalInvBatchNo?: string;
    public ExemptFromLateFee?: boolean;

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

export class SalesForceInvoiceCollection
{
    public InvoiceCollection?: SalesForceInvoice[];

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

TypeScript SalesForceInvoiceCollection DTOs

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

HTTP + CSV

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

POST /api/SalesForce/InvoiceCollection HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InvoiceCollection":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","OpportunityId":"String","InvoiceDueDate":"0001-01-01T00:00:00.0000000","Installments":0,"Frequency":0,"BhUserId":0,"Description":"String","Deliver":false,"CurrencyType":"String","InvoiceItems":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ProductName":"String","AmountDue":"String","ProductType":"String","ActPatternTypeId":0,"TermStartDate":"0001-01-01T00:00:00.0000000","TermEndDate":"0001-01-01T00:00:00.0000000","RecognitionPeriod":0,"RevenueAccount":"String","AccountsReceivableAccount":"String","LiabilityAccount":"String","CreditExpenseAccount":"String","InvoiceClearingAccount":"String","CostCenter":"String","Region":"String"}],"InvoiceNo":0,"InvoiceAmt":0,"ExternalInvBatchNo":"String","ExemptFromLateFee":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"InvoiceReply":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ErrorCode":0,"ErrorMessage":"String","InvBatchNo":0,"InvAmount":0}],"IsError":false}