GET api/invoice/{InvoiceID}

This API method returns an invoices' details including the invoice file as a base64 encoded byte array. Only production invoices or reports with a respective generated PDF can be retrieved. 404 will be returned if no file is found CP, RS and Agent Users all can retrieve files for which they have authorisation

Error Messages
  • 500/Internal Server Error - Error getting Invoice ID x
  • 404/Not found - No invoice found with ID x
  • 500/Not Found - No invoice 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 file - formatted as a base64 encoded bye array Collection of byte

None.

ID Invoice ID number integer

None.

InvoiceFileName Name of invoice file string

None.

ReportFileName Name of invoice report string

None.

InvoiceNumber Number of invoice - 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 invoice is created against string

None.

BillingPeriodDate Billing period date date

None.

BillingMonth Billing period month string

None.

ServiceCharges Cost of 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 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.