PATCH api/site/{id}/billinginformation

Update all the billing information details for the specified site

Error Messages
  • 400/BadRequest - Payment Information: Insufficient permission to edit payment information.
  • 400/BadRequest - Payment Method: A payment condition needs specifying to update the payment details.
  • 404/Not Found - Site with ID x not found - Specified site ID not assigned to a site
  • 404/Not Found - Billing contact with id = x is not a contact for site with id = x - Specified Billing Contact ID is not found on site with the specified ID
  • 400/Bad Request - CreditCardInformation.IssueNumber - Length must be 6 characters or less/li>

Request Information

URI Parameters

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

Required

Body Parameters

BillingInformationModify
NameDescriptionTypeAdditional information
BillingContactId The ID of the Billing Contact integer

None.
Email The email address of the Billing Contact string

Matching regular expression pattern: ^(([a-zA-Z0-9_\-\.]+)@((\[?[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\]?)|(([a-zA-Z0-9\-]+\.)+)([a-zA-Z0-9]{2,63}))(\s*;\s*|\s*$))*$

String length: inclusive between 0 and 255
PaymentTerms Specify how long the payment term is integer

Range: inclusive between -999 and 9999
PaymentConditionsId Specify how the payment is made integer

None.
DirectDebitInformation Specify the Direct Debit Information DirectDebitInfo

None.
CreditCardInformation Specify the Credit Card information CreditCardInfo

None.

Request Formats

application/json, text/json

Sample: 
{
  "BillingContactId": 1,
  "Email": "sample string 1",
  "PaymentTerms": 1,
  "PaymentConditionsId": 1,
  "DirectDebitInformation": {
    "SortCode": "sample string 1",
    "AccountNumber": "sample string 2",
    "AccountName": "sample string 3",
    "CustomerReference": "sample string 4",
    "IsCancelled": true,
    "CancellationDetails": {
      "DateCancelled": "2025-04-25T02:03:31.442",
      "CancellationReason": "sample string 1"
    }
  },
  "CreditCardInformation": {
    "CardType": "sample string 1",
    "CardNumber": "sample string 2",
    "StartYear": 1,
    "StartMonth": 1,
    "ExpirationYear": 1,
    "ExpirationMonth": 1,
    "IssueNumber": "sample string 3"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.