Charge Object.

v1.0.0

Returns Charge Object.

Logical Operators

Connector	Description	Example
AND	Find data containing all connected terms.	google AND facebook
OR	Find data containing any connected term.	order OR decision
NOT	Exclude data.	google NOT apple.
“[phrase]”	Find an exact phrase.	"Google Inc”
( … )	Parenthesis may be used to group sets of terms of connectors.	google (facebook OR apple).

All Filter Query parameters supported for this API can be found in below schema section. Schema --> ChargeQueryObject

Input

{
  "type": "object",
  "properties": {
    "order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "pageNumber": {
      "type": "integer"
    },
    "q": {
      "type": "string"
    },
    "sort": {
      "type": "string",
      "enum": [
        "name"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "chargeArray",
    "nextPageAPI",
    "object",
    "pageNumber",
    "previousPageAPI",
    "totalCount",
    "totalPages"
  ],
  "properties": {
    "chargeArray": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "object",
          "chargeId",
          "chargeGroupId",
          "chargeGroup",
          "name",
          "createdDate"
        ],
        "properties": {
          "chargeGroup": {
            "type": "string"
          },
          "chargeGroupId": {
            "type": "string"
          },
          "chargeId": {
            "type": "string"
          },
          "createdDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time when it was first created. This date and time is in UTC. Formatted as YYYY-MM-DD HH:MM:SS."
          },
          "name": {
            "type": "string"
          },
          "object": {
            "type": "string"
          }
        }
      }
    },
    "nextPageAPI": {
      "type": "string",
      "format": "uri",
      "description": "Link to next page."
    },
    "object": {
      "type": "string"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number for which results where obtained."
    },
    "previousPageAPI": {
      "type": "string",
      "format": "uri",
      "description": "Link to previous page."
    },
    "totalCount": {
      "type": "integer",
      "description": "Total number of matches found."
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages to obtain all the objects."
    }
  }
}