PATCH api/site/{id}/invoiceinformation

This method updates selected invoice information details for the specified site

Error Messages
  • 404/NotFound: Site with id = X not found - Specified ID is not assigned to a site
  • 404/NotFound: validateText

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id The unique identifier for the Site being queried. integer

Required

Body Parameters

InvoiceInformationModify
NameDescriptionTypeAdditional information
DataFilePassword The password for the Data File string

String length: inclusive between 0 and 50
ReportDelivery The report delivery ID integer

None.
InvoiceDelivery The invoice delivery ID integer

None.
MinimumItemisation The lowest call charge to appear on a report decimal number

None.
BillRun The Bill Run ID integer

None.
ReportProfile The report file ID integer

None.
InvoiceText Any additional text to add to the invoice string

String length: inclusive between 0 and 200
TaxCode The tax code ID integer

None.
DataDelivery The delivery method ID for CDR and Service Charge Export files integer

None.
DataFileLocation Specify The location of the CDR and Service Charge Export files string

String length: inclusive between 0 and 255
CDRFormat The format of the CDR export file string

String length: inclusive between 0 and 32
ServiceFormat The format of the Service Charge Export Format string

String length: inclusive between 0 and 32
CreateSingleDataFile Specify whether the file is a single data file boolean

None.
ZipDataFile Specify whether the files will be zipped boolean

None.
DataFileIsPasswordEnabled If the files are zipped, specify whether the zipped files are password protected boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "DataFilePassword": "sample string 1",
  "ReportDelivery": 1,
  "InvoiceDelivery": 1,
  "MinimumItemisation": 1.0,
  "BillRun": 1,
  "ReportProfile": 1,
  "InvoiceText": "sample string 2",
  "TaxCode": 1,
  "DataDelivery": 1,
  "DataFileLocation": "sample string 3",
  "CDRFormat": "sample string 4",
  "ServiceFormat": "sample string 5",
  "CreateSingleDataFile": true,
  "ZipDataFile": true,
  "DataFileIsPasswordEnabled": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.