GET api/Bills/{id}

Retrieves information for a bill.

Request

Parameters

Name Description Default
id Bill number or unique bill ID.

Response

Body

Content Type: application/xml
Exported bill or an error message.

XML
<Bill id="long" number="string" type="string" status="string" historicalCode="string">    
  <ApplyGST>bool</ApplyGST>                                                               <!--Whether GST is applied to the bill--> 
  <BillToDate>datetime</BillToDate>                                                       <!--Bill up to and including--> 
  <OpeningBalance>decimal</OpeningBalance>                                                
  <Credits>decimal</Credits>                                                              
  <ClosingBalance>decimal</ClosingBalance>                                                
  <Discount percent="decimal" daysValid="int" code="string">                              
    <Amount>decimal</Amount>                                                              
    <GST>decimal</GST>                                                                    
    <Description>string</Description>                                                     
  </Discount>                                                                             
  <Documents>                                                                             
    <Related id="long">string</Related>                                                   
    <Authority id="long">string</Authority>                                               
    <Power id="long">string</Power>                                                       
  </Documents>                                                                            
  <DraftedBy>string</DraftedBy>                                                           <!--Code of member who drafted the bill--> 
  <DraftedDate>datetime</DraftedDate>                                                     
  <FinalisedBy>string</FinalisedBy>                                                       <!--Code of member who finalised the bill--> 
  <FinalisedDate>datetime</FinalisedDate>                                                 
  <DueDate>datetime</DueDate>                                                             
  <File id="long">string</File>                                                           
  <Interest mode="string" rate="decimal">decimal</Interest>                               <!--Interest amount--> 
  <IssuedDate>datetime</IssuedDate>                                                       
  <ItemsToInclude>string</ItemsToInclude>                                                 
  <Totals>                                                                                
    <Net>decimal</Net>                                                                    
    <GST>decimal</GST>                                                                    
    <Gross>decimal</Gross>                                                                
  </Totals>                                                                               
  <TrustTransfer allocation="string">                                                     
    <Date>datetime</Date>                                                                 
    <Amount>decimal</Amount>                                                              
  </TrustTransfer>                                                                        
  <Products>                                                                              <!--Array of 'Product'--> 
    <Product id="long">                                                                   
      <Description>string</Description>                                                   
      <Qty>int</Qty>                                                                      
      <Amount>decimal</Amount>                                                            
      <GST>decimal</GST>                                                                  
    </Product>                                                                            
  </Products>                                                                             
  <Disbursements>                                                                         <!--Array of 'Disbursement'--> 
    <Disbursement id="long">                                                              
      <Date>datetime</Date>                                                               
      <Description>string</Description>                                                   
      <Net>decimal</Net>                                                                  
      <GST>decimal</GST>                                                                  
      <Gross>decimal</Gross>                                                              
    </Disbursement>                                                                       
  </Disbursements>                                                                        
  <AnticipatedDisbs>                                                                      <!--Array of 'AnticipatedDisb'--> 
    <AnticipatedDisb id="long">                                                           
      <Description>string</Description>                                                   
      <Net>decimal</Net>                                                                  
      <GST>decimal</GST>                                                                  
      <Gross>decimal</Gross>                                                              
    </AnticipatedDisb>                                                                    
  </AnticipatedDisbs>                                                                     
  <OtherItems>                                                                            <!--Array of 'OtherItem'--> 
    <OtherItem id="long" flags="string">                                                  
      <Description>string</Description>                                                   
      <Net>decimal</Net>                                                                  
      <GST>decimal</GST>                                                                  
      <Gross>decimal</Gross>                                                              
    </OtherItem>                                                                          
  </OtherItems>                                                                           
</Bill>                                                                                   

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid bill ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenUser does not have permission to view the bill.
404 Not FoundBill not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.