Update a site.

patch/sites/{site_id}
SecuritybearerAuth
Request
path Parameters
site_id
required
integer <int64> (IdParam) >= 1

Site identifier

Example: 1
header Parameters
cascade_end_date
string (BooleanFilterParam)

A boolean flag to specify that the end date is to be cascaded down to all inventories. An end date must be supplied in the patch for this flag to apply.

Example: true | false
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "replace",
    • "path": "/name",
    • "value": "Head Office"
    }
]
Response samples
application/json
{
  • "id": 1,
  • "customerId": 0,
  • "siteName": "string",
  • "siteReference": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "siteAddress": {
    • "id": 1,
    • "businessName": "string",
    • "address1": "string",
    • "address2": "string",
    • "address3": "string",
    • "town": "string",
    • "county": "string",
    • "postcode": "string",
    • "country": "GB"
    },
  • "siteInvoiceDetails": {
    • "invoiceSummaryTemplateId": 0,
    • "invoiceTemplateId": 0,
    • "invoiceAddress": {
      • "id": 1,
      • "businessName": "string",
      • "address1": "string",
      • "address2": "string",
      • "address3": "string",
      • "town": "string",
      • "county": "string",
      • "postcode": "string",
      • "country": "GB"
      },
    • "accountPackageReference": "string",
    • "paymentTermsInDays": 400,
    • "preferredPaymentDay": 1,
    • "paymentMethod": "CHEQUE",
    • "mandateStatus": "string",
    • "mandateCreatedDate": "2019-08-24T14:15:22Z",
    • "mandateUpdatedDate": "2019-08-24T14:15:22Z",
    • "mandateReference": "string",
    • "directDebitReference": "string",
    • "accountName": "string",
    • "accountNumber": "stringst",
    • "sortCode": "string",
    • "purchaseOrderNumber": "string",
    • "invoiceNotes": "string",
    • "taxExempt": false,
    • "taxRegistrationNumber": "string"
    },
  • "siteIdReceivingInvoice": 1,
  • "siteContacts": [
    • {
      • "id": 1,
      • "contactName": "string",
      • "contactTelephoneNumber": "string",
      • "contactAlternativeTelephoneNumber": "string",
      • "contactEmailAddress": "string",
      • "contactRole": "ACCOUNTS",
      • "receiveInvoiceBy": "EMAIL",
      • "receiveInvoiceSummaryBy": "EMAIL",
      • "receiveElectronicSummaryReports": true,
      • "emailSuspended": false,
      • "contactNameToAppearOnInvoice": false,
      • "receiveEmailFraudAlert": false,
      • "receiveSmsFraudAlert": false
      }
    ],
  • "repaymentPlanAmount": 1,
  • "repaymentPlanRemainingPeriods": 0
}