Developer Guide

HTTP CODE: 200 OK
[
  {
    "customerID": 304,
    "customerNoteID": 74,
    "DateUTC": "2016-03-15T14:23:37.3084056Z",
    "Note": "Test customer note message",
    "NoteType": "General"
  },
  {
    "customerID": 304,
    "customerNoteID": 75,
    "DateUTC": "2016-03-15T14:23:48.362563Z",
    "Note": "Test customer note message 2",
    "NoteType": "General"
  },
  {
    "customerID": 304,
    "customerNoteID": 76,
    "DateUTC": "2016-03-17T09:06:33.3187225Z",
    "Note": "Test customer note message 3",
    "NoteType": "General"
  }
]

Returns a list off all customer notes linked to the logged in account

URL

GET https://api.billagain.com/v1/customernotes

URL PARAMETERS (2 Fields)

OUTPUT PARAMETERS (5 Fields)

EXAMPLES

JSON Output

HTTP CODE: 200 OK
[
  {
    "customerID": 222,
    "customerNoteID": 61,
    "DateUTC": "2015-06-02T14:11:51.2796042Z",
    "Note": "Test note message",
    "NoteType": "General"
  },
  {
    "customerID": 231,
    "customerNoteID": 63,
    "DateUTC": "2015-06-17T13:19:36.5054009Z",
    "Note": "Test note message 2",
    "NoteType": "General"
  }
]

Returns a specific customer note

URL

GET https://api.billagain.com/v1/customernotes/{customerNoteID}

URL PARAMETERS (1 Field)

OUTPUT PARAMETERS (5 Fields)

EXAMPLES

JSON Output

HTTP CODE: 200 OK
{
  "customerID": 304,
  "customerNoteID": 74,
  "DateUTC": "2016-03-15T14:23:37.3084056Z",
  "Note": "Test customer note message",
  "NoteType": "General"
}

Adds a customer note to the customer which is linked to your account

URL

POST https://api.billagain.com/v1/customernotes

INPUT PARAMETERS (3 Fields)

OUTPUT PARAMETERS (5 Fields)

EXAMPLES

JSON Input

{
  "customerID": 304,
  "Note": "My Customer Note",
  "NoteType": "General"
}

JSON Output

HTTP CODE: 201 Created
{
  "customerID": 304,
  "customerNoteID": 77,
  "DateUTC": "2016-04-03T13:27:14.2987136Z",
  "Note": "My Customer Note",
  "NoteType":  "General"
}

Edits a customer's note linked to your account

URL

PUT https://api.billagain.com/v1/customernotes/{customerNoteID}

URL PARAMETERS (1 Field)

INPUT PARAMETERS (3 Fields)

EXAMPLES

JSON Input

{
  "Note": "My New Customer Note",
   "NoteType": "General"
}

JSON Output

HTTP CODE: 204 No Content

Delete a customer note from your account

URL

DELETE https://api.billagain.com/v1/customernotes/{customerNoteID}

URL PARAMETERS (1 Field)

EXAMPLES

JSON Output

HTTP CODE: 204 No Content