GET api/site/{id}/billinginformation
Return the billing information details for the specified site
Error Messages
- 401/Unauthorized: CompanySitePermission - User does not have the permissions to view this company's Billing i
- 404/NotFound: Site with id = X not found - Specified ID not assigned to a site
- 404/NotFound: No billing information found for site with id = x - No Billing Information found on the specified site ID. Use PUT-api-site-id-billinginformation to add Billing Information a site
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | The unique identifier for the Site being queried. | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
BillingInformationViewName | Description | Type | Additional information |
---|---|---|---|
Id | The Site ID | integer |
None. |
BillingContact | The Billing Contact | string |
None. |
PaymentConditions | How payment is made | string |
None. |
isBillingInfoRedacted | boolean |
None. |
|
BillingContactId | The Billing Contact ID | integer |
None. |
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 | How many days that the payment is due | integer |
Range: inclusive between -999 and 9999 |
PaymentConditionsId | The ID of the payment type | integer |
None. |
DirectDebitInformation | Direct Debit Information for that site | DirectDebitInfo |
None. |
CreditCardInformation | Credit Card information for that site | CreditCardInfo |
None. |