Commit 6bdc6b04 authored by Shreyash Shrestha's avatar Shreyash Shrestha
Browse files

Merge branch 'Service' into 'master'

Update service and getting access docs

See merge request !4
parents cf80b678 35acb459
Loading
Loading
Loading
Loading
+2 −9
Original line number Diff line number Diff line
## Getting Access

Currently, access to the Billing Service is handled through JWT tokens. If you are looking to access the Billing Service and use its functionality please email us (doit-billing-service-support@office365.wisc.edu).

Please include the following information in the email:
* Your name
* Your email address
* The name of the service
* The name of the department in-charge of the service

Once your request is reviewed and approved, we will notify you and provide you a JWT token for access.
 No newline at end of file
Please navigate to the [UW Madison Developer Portal](https://developer.wisc.edu) to discover the Billing Service API
and follow the instructions to access the Billing Service API.
 No newline at end of file
+22 −7
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ This service allows DoIT Service Providers to send bills for their users to CBS.
The goal of this service is to consolidate billing processes that interact with CBS.
This will allow us to easily switch to a different financial application if CBS were to be replaced, without affecting the billing processes.

Our initial clients are SEO Service Providers for infrastructure services including Physical Server Hosting, Virtual Server Hosting, Bucky Backup and Enterprise Storage, with the intention to expand to other SEO services like Cloud, Azure, etc.
Our clients are SEO Service Providers for infrastructure services including Physical Server Hosting, Virtual Server Hosting, Bucky Backup, Enterprise Storage, and Cloud Services.

We also intend the Billing Service to be used for reporting purposes and customer inquiries.
Please see [Reporting Database](./docs/reporting-database.md) for more information.
@@ -14,6 +14,7 @@ Please see [Reporting Database](./docs/reporting-database.md) for more informati
### OpenAPI Specification

Here is a link to our OpenAPI Specification: https://api.test.billing.doit.wisc.edu/api-docs/
or navigate to the [UW Madison Developer Portal](https://developer.wisc.edu) to discover the Billing Service API.

The OpenAPI Specification includes descriptions of Billing Service resources and their properties, the available endpoints and supported methods, and examples of requests and responses.
This is the primary location for our API Documentation. Any changes to our API will first be reflected in the OpenAPI Specification.
@@ -154,6 +155,26 @@ The `inventoryNumber` property is required for a `Service` resource to be valid.
This provides CBS information regarding where the revenue should go. 

Service owners are responsible for registering a service with CBS.

As a client you can `POST` new services with the required `inventoryNumber`, `inventoryDescription`, `billable`, and
`cbsName` properties.

The `inventoryNumber`, `inventoryDescription` should be available to Service Owners.

Financial Services team should have the correct `cbsName` value for the service in question.

__Example__

A `Service` resource with required properties.
```
{
  "cbsName": "STORAGE",
  "billable": true,
  "inventoryNumber": "70701",
  "inventoryDescription": "AWS Cloud Billing"
}
```

Please contact Financial Services for more information (projectbilling@doit.wisc.edu) regarding registering a Service.

### Resources
@@ -176,9 +197,3 @@ To further familiarize yourself with REST APIs please use the resources below:
* Chargeback charges are checked for updates to determine when they are submitted and processed by CBS
  * If a charge has an error and was unable to be submitted to CBS the error will be saved to a dashboard
* Errors are reviewed on the dashboard and resolved which causes the charge to be submitted

## Related Documentation

* [Getting Access](./docs/getting-access.md)
* [Reporting Database](./docs/reporting-database.md)
* [Support and Feedback](./docs/support-and-feedback.md)