Billhighway Cloud API

<back to all web services

InvoiceCollection

The following routes are available for this service:
POST/invoices/misc
InvoiceCollection Parameters:
NameParameterData TypeRequiredDescription
InvoiceListbodyList<Invoice>No
Invoice Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ClientIdformintNo
GroupIdformstringNo
DescriptionformstringNo
OpportunityIdformstringNo
InstallmentsformintNo
FrequencyformintNo
InvoiceDueDateformDateTimeNo
DeliverformboolNo
UserIdformstringNo
BhUserIdformintNo
CurrencyTypeformstringNo
InvoiceItemsformList<InvoiceItem>No
InvoiceNoformintNo
InvoiceAmtformdecimalNo
InvoiceItem Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ProductNameformstringNo
AmountDueformdecimalNo
ProductTypeformstringNo
ActPatternTypeIDformintNo
TermStartDateformDateTimeNo
TermEndDateformDateTimeNo
RecognitionPeriodformintNo
RevenueAccountformstringNo
AccountsReceivableAccountformstringNo
LiabilityAccountformstringNo
CreditExpenseAccountformstringNo
InvoiceClearingAccountformstringNo
CostCenterformstringNo
RegionformstringNo
InvoiceCollectionReply Parameters:
NameParameterData TypeRequiredDescription
InvoiceReplyformList<InvoiceReply>No
IsErrorformboolNo
InvoiceReply Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ErrorCodeformintNo
ErrorMessageformstringNo
InvBatchNoformintNo
InvAmountformdecimalNo

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