GET api/invoice/{InvoiceID}/report

This API method returns an invoices' details including the report file as a base64 encoded byte array

Error Messages
  • 500/Internal Server Error - Error getting invoice ID x
  • 404/Not Found - No invoice found with ID x
  • 404/Not Found - No invoice file found for x
  • 404/Not found - No report file found for ID x
  • Request Information

    URI Parameters

    NameDescriptionTypeAdditional information
    InvoiceID Filter by invoice ID integer

    Required

    Body Parameters

    None.

    Response Information

    Resource Description

    InvoiceFileView class

    InvoiceFileView
    NameDescriptionTypeAdditional information
    Content Invoice report file - formatted as a base64 encoded bye array Collection of byte

    None.

    ID Invoice ID number integer

    None.

    InvoiceFileName Name of the invoice file string

    None.

    ReportFileName Name of the invoice report string

    None.

    InvoiceNumber Number of the nvoice - created upon dispatch integer

    None.

    isApproved Will be True if invoice has been approved boolean

    None.

    SiteID Billing Site ID number integer

    None.

    SiteName Name of site the invoice is created against string

    None.

    BillingPeriodDate Billing period date date

    None.

    BillingMonth Billing period month string

    None.

    ServiceCharges Cost of the Service Charges decimal number

    None.

    Calls Cost of calls decimal number

    None.

    Total Sub total decimal number

    None.

    VAT Value Added Tax decimal number

    None.

    TotalIncVAT Sub-total plus VAT decimal number

    None.

    InvoiceDate Date the invoice was dispatched date

    None.

    Address Invoice Address string

    None.

    Town Invoice Town string

    None.

    County Invoice County string

    None.

    PostCode Invoice Postcode string

    None.