Billhighway Cloud API

<back to all web services

InvoiceCollection

The following routes are available for this service:
POST/invoices/misc
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.SalesForce;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class Invoice
        : IInvoiceValidation
    {
        public Invoice()
        {
            InvoiceItems = new List<InvoiceItem>{};
        }

        public virtual string UniqueId { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string Description { get; set; }
        public virtual string OpportunityId { get; set; }
        public virtual int Installments { get; set; }
        public virtual int Frequency { get; set; }
        public virtual DateTime InvoiceDueDate { get; set; }
        public virtual bool Deliver { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual List<InvoiceItem> InvoiceItems { get; set; }
        public virtual int InvoiceNo { get; set; }
        public virtual decimal InvoiceAmt { get; set; }
        public virtual string ExternalInvBatchNo { get; set; }
        public virtual bool ExemptFromLateFee { get; set; }
    }

    public partial class InvoiceItem
        : IInvoiceItemValidation
    {
        public virtual string UniqueId { get; set; }
        public virtual string ProductName { get; set; }
        public virtual decimal AmountDue { get; set; }
        public virtual string ProductType { get; set; }
        public virtual int ActPatternTypeID { get; set; }
        public virtual DateTime TermStartDate { get; set; }
        public virtual DateTime TermEndDate { get; set; }
        public virtual int RecognitionPeriod { get; set; }
        public virtual string RevenueAccount { get; set; }
        public virtual string AccountsReceivableAccount { get; set; }
        public virtual string LiabilityAccount { get; set; }
        public virtual string CreditExpenseAccount { get; set; }
        public virtual string InvoiceClearingAccount { get; set; }
        public virtual string CostCenter { get; set; }
        public virtual string Region { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class InvoiceCollection
    {
        public InvoiceCollection()
        {
            InvoiceList = new List<Invoice>{};
        }

        public virtual List<Invoice> InvoiceList { get; set; }
    }

    public partial class InvoiceCollectionReply
        : IHaveErrorField
    {
        public InvoiceCollectionReply()
        {
            InvoiceReply = new List<InvoiceReply>{};
        }

        public virtual List<InvoiceReply> InvoiceReply { get; set; }
        public virtual bool IsError { get; set; }
    }

    public partial class InvoiceReply
    {
        public virtual string UniqueId { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        public virtual int InvBatchNo { get; set; }
        public virtual decimal InvAmount { get; set; }
    }

}

C# InvoiceCollection DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<InvoiceCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <InvoiceList>
    <Invoice>
      <BhUserId>0</BhUserId>
      <ClientId>0</ClientId>
      <CurrencyType>String</CurrencyType>
      <Deliver>false</Deliver>
      <Description>String</Description>
      <ExemptFromLateFee>false</ExemptFromLateFee>
      <ExternalInvBatchNo>String</ExternalInvBatchNo>
      <Frequency>0</Frequency>
      <GroupId>String</GroupId>
      <Installments>0</Installments>
      <InvoiceAmt>0</InvoiceAmt>
      <InvoiceDueDate>0001-01-01T00:00:00</InvoiceDueDate>
      <InvoiceItems>
        <InvoiceItem>
          <AmountDue>String</AmountDue>
          <ProductName>String</ProductName>
          <RevenueAccount>String</RevenueAccount>
        </InvoiceItem>
      </InvoiceItems>
      <InvoiceNo>0</InvoiceNo>
      <OpportunityId>String</OpportunityId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </Invoice>
  </InvoiceList>
</InvoiceCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceCollectionReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <InvoiceReply>
    <InvoiceReply>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <InvAmount>0</InvAmount>
      <InvBatchNo>0</InvBatchNo>
      <UniqueId>String</UniqueId>
    </InvoiceReply>
  </InvoiceReply>
</InvoiceCollectionReply>