{
"openapi": "3.1.0",
"x-proxy-enabled": false,
"info": {
"version": "v10",
"title": "LogiSense Billing API"
},
"servers": [
{
"url": "https://{server_address}/ResourceServer/api/v10",
"description": "API server with configurable address",
"variables": {
"server_address": {
"default": "api.example.com",
"description": "The base domain or IP address of the server"
}
}
},
{
"url": "https://{server_address}/AuthorizationServer/api/v10",
"description": "Authorization server with configurable address used for authentication",
"variables": {
"server_address": {
"default": "api.example.com",
"description": "The base domain or IP address of the server"
}
}
}
],
"security": [
{
"BearerAuth": []
}
],
"paths": {
"/Access/Login": {
"post": {
"operationId": "POST_Access_Login",
"summary": "Authenticate and return a JWT",
"security": [],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string",
"format": "password"
},
"grant_type": {
"type": "string",
"enum": [
"password",
"refresh_token"
],
"description": "Authentication method to use"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string",
"format": "password"
}
},
"required": [
"grant_type",
"client_id"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful authentication",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "JWT access token used to authorize API requests",
"example": "eyJ0eXAiOiJKV1QiLCJhbGciOi..."
},
"refresh_token": {
"type": "string",
"description": "Token used to obtain a new access token",
"example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9..."
},
"token_type": {
"type": "string",
"description": "Type of token returned",
"example": "bearer"
},
"expires_in": {
"type": "integer",
"description": "Number of seconds until the access token expires",
"example": 1800
},
"audience": {
"type": "string",
"description": "Audience value associated with the token",
"example": "044b8ad6006845c29446b2f18e5b5909"
},
".issued": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp indicating when the token was issued",
"example": "2022-11-01T19:49:41Z"
},
".expires": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp indicating when the token expires",
"example": "2022-11-01T20:19:41Z"
},
"actingOwnerId": {
"type": "integer",
"description": "Owner ID associated with the authenticated session",
"example": 1
}
},
"required": [
"access_token",
"refresh_token",
"token_type",
"expires_in",
"audience",
".issued",
".expires",
"actingOwnerId"
]
},
"example": {
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOi...",
"refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...",
"token_type": "bearer",
"expires_in": 1800,
"audience": "044b8ad6006845c29446b2f18e5b5909",
".issued": "2022-11-01T19:49:41Z",
".expires": "2022-11-01T20:19:41Z",
"actingOwnerId": 1
}
}
}
}
}
}
},
"/Account/{id}/Contact": {
"get": {
"operationId": "GET_Account_id_Contact",
"summary": "List Contact records for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"post": {
"operationId": "POST_Account_id_Contact",
"summary": "Create a Contact record for the specified Account.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_id_Contact",
"summary": "Update a Contact record for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Contact for Account"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_id_Contact",
"summary": "Delete a Contact record from the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Contact/Paged": {
"get": {
"operationId": "GET_Account_id_Contact_Paged",
"summary": "List Contact records for the specified Account with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Contact/{contactId}": {
"get": {
"operationId": "GET_Account_id_Contact_contactId",
"summary": "Retrieve a Contact record for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Contact"
}
}
}
]
}
}
},
"description": "Get a Contact by its ID based on a specified Account"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "contactId",
"required": true,
"description": "Unique identifier for the Contact object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_id_Contact_contactId",
"summary": "Delete a Contact/{contactId} record from the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "contactId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Contact/{contactId}/Detail": {
"get": {
"operationId": "GET_Account_id_Contact_contactId_Detail",
"summary": "Retrieve a Account record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Account"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "contactId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account": {
"get": {
"operationId": "GET_Account",
"summary": "List Account records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account",
"summary": "Create a Account record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Account"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Account"
}
]
}
}
}
}
}
},
"/Account/Paged": {
"get": {
"operationId": "GET_Account_Paged",
"summary": "List Account records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Paged/Detail": {
"get": {
"operationId": "GET_Account_Paged_Detail",
"summary": "List Account records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/{id}": {
"get": {
"operationId": "GET_Account_id",
"summary": "Retrieve a Account record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Account"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_id",
"summary": "Update a Account record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Account"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Account"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_id",
"summary": "Patch a Account record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Account"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_id",
"summary": "Delete a Account record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Detail": {
"get": {
"operationId": "GET_Account_id_Detail",
"summary": "Retrieve a Account record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Account"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Patch": {
"post": {
"operationId": "POST_Account_id_Patch",
"summary": "POST wrapper for patching an account.",
"responses": {
"200": {
"description": "Account updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Compatibility route that applies the same patch behavior as PATCH `/Account/{id}` for clients that can only submit POST requests."
}
},
"/Account/{id}/Note": {
"get": {
"operationId": "GET_Account_id_Note",
"summary": "List Note records for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Note"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"post": {
"operationId": "POST_Account_id_Note",
"summary": "Create a Note record for the specified Account.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Note"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_id_Note",
"summary": "Update a Note record for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Note for Account"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Note"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_id_Note",
"summary": "Delete a Note record from the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Note/Paged": {
"get": {
"operationId": "GET_Account_id_Note_Paged",
"summary": "List Note records for the specified Account with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Note"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/Note/{noteId}": {
"get": {
"operationId": "GET_Account_id_Note_noteId",
"summary": "Retrieve a Note record for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Note"
}
}
}
]
}
}
},
"description": "Get a Note by its ID based on a specified Account"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "noteId",
"required": true,
"description": "Unique identifier for the Note object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_id_Note_noteId",
"summary": "Delete a Note/{noteId} record from the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "noteId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/TaxAddress/AvailableFor": {
"get": {
"parameters": [
{
"description": "Unique identifier of the account.",
"name": "id",
"required": true,
"schema": {
"example": 1024,
"type": "integer"
},
"in": "path"
}
],
"summary": "Retrieve tax addresses that are available for the specified account.",
"description": "Returns tax address choices that can be associated with the account. The response is optimized for selection and linking workflows.",
"operationId": "GET_Account_id_TaxAddress_AvailableFor",
"responses": {
"200": {
"description": "List of tax addresses available to associate with the account.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountTaxAddressAvailableForResponse"
}
}
}
},
"400": {
"description": "Error occurred during this request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/{id}/TaxAddress": {
"get": {
"parameters": [
{
"description": "Unique identifier of the account.",
"name": "id",
"required": true,
"schema": {
"example": 1024,
"type": "integer"
},
"in": "path"
}
],
"summary": "Retrieve the tax addresses associated with the specified account.",
"description": "Returns the tax address records currently linked to the account, including address details and the invoicer context for each tax address.",
"operationId": "GET_Account_id_TaxAddress",
"responses": {
"200": {
"description": "List of tax addresses associated with the account.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountTaxAddressResponse"
}
}
}
},
"400": {
"description": "Error occurred during this request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/{id}/Balance": {
"get": {
"operationId": "GET_Account_id_Balance",
"summary": "Retrieve the Account Balance and the Balance Due for a specified Account ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountIdBalanceResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/ByName": {
"get": {
"operationId": "GET_Account_ByName",
"summary": "Search accounts using a specialized query.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
]
}
}
},
"description": "List of matching accounts."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"in": "query",
"required": false,
"name": "accountName",
"description": "Account name to search for.",
"schema": {
"type": "string",
"example": "Acme Telecom"
}
},
{
"in": "query",
"required": false,
"name": "operator",
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "contains"
}
}
],
"description": "Returns accounts that match the supplied search criteria."
}
},
"/Account/ByHierarchy": {
"get": {
"operationId": "GET_Account_ByHierarchy",
"summary": "Search accounts using a specialized query.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
]
}
}
},
"description": "List of matching accounts."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"in": "query",
"required": false,
"name": "accountParentName",
"description": "Parent account name to search for.",
"schema": {
"type": "string",
"example": "Acme Group"
}
},
{
"in": "query",
"required": false,
"name": "operator",
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "contains"
}
}
],
"description": "Returns accounts that match the supplied search criteria."
}
},
"/Account/ByExtension": {
"get": {
"operationId": "GET_Account_ByExtension",
"summary": "Search accounts using a specialized query.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
]
}
}
},
"description": "List of matching accounts."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"in": "query",
"required": false,
"name": "extensions",
"description": "Extension keys to search against.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"crmId"
]
}
},
{
"in": "query",
"required": false,
"name": "extensionValue",
"description": "Extension value to match.",
"schema": {
"type": "string",
"example": "ABC-123"
}
},
{
"in": "query",
"required": false,
"name": "operator",
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "equals"
}
}
],
"description": "Returns accounts that match the supplied search criteria."
}
},
"/Account/{id}/PriceBookRegion": {
"get": {
"operationId": "GET_Account_id_PriceBookRegion",
"summary": "List PriceBookRegion records for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/ByBillingContact": {
"get": {
"operationId": "GET_Account_ByBillingContact",
"summary": "Search accounts using a specialized query.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
]
}
}
},
"description": "List of matching accounts."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"in": "query",
"required": false,
"name": "value",
"description": "Billing contact value to search for.",
"schema": {
"type": "string",
"example": "billing@mydomain.com"
}
},
{
"in": "query",
"required": false,
"name": "operator",
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "contains"
}
}
],
"description": "Returns accounts that match the supplied search criteria."
}
},
"/Account/SimulatePackageBilling": {
"post": {
"operationId": "POST_Account_SimulatePackageBilling",
"summary": "Simulate cancelling a set of AccountPackages for a given account and replacing them with new AccountPackages.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SimulatePackageBillingResult"
}
}
},
"description": "Create a new instance of a Account"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SimulatePackageBillingParam"
}
]
}
}
}
},
"description": " The API response will contain the invoice items that would be created for the account-packages in the next bill run as well as the total amount."
}
},
"/Account/Contract": {
"get": {
"operationId": "GET_Account_Contract",
"summary": "List AccountContract records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContract"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Contract",
"summary": "Create a AccountContract record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountContract"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountContract"
}
]
}
}
}
}
}
},
"/Account/Contract/Paged": {
"get": {
"operationId": "GET_Account_Contract_Paged",
"summary": "List AccountContract records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContract"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Paged/Detail": {
"get": {
"operationId": "GET_Account_Contract_Paged_Detail",
"summary": "List AccountContract records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContract"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/{id}": {
"get": {
"operationId": "GET_Account_Contract_id",
"summary": "Retrieve a AccountContract record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContract"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Contract_id",
"summary": "Update a AccountContract record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountContract"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountContract"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_Contract_id",
"summary": "Patch a AccountContract record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountContract"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Contract_id",
"summary": "Delete a AccountContract record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/{id}/Detail": {
"get": {
"operationId": "GET_Account_Contract_id_Detail",
"summary": "Retrieve a AccountContract record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContract"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/{id}/EarlyTermination": {
"put": {
"operationId": "PUT_Account_Contract_id_EarlyTermination",
"summary": "This method can be used both as a PUT or a DELETE for EarlyTermination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EarlyTermination for AccountContract"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractEarlyTerminationParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": " A PUT allows an EarlyTermination date to be set with the options to add an EarlyTerminationComment and or a Termination_AccountContractStatusTypeID. A DELETE clears the EarlyTermination date and EarlyTerminationComment fields on the AccountContract. NOTE: earlyTerminationComment and terminationAccountContractStatusType are optional."
},
"delete": {
"operationId": "DELETE_Account_Contract_id_EarlyTermination",
"summary": "Delete a EarlyTermination record from the specified AccountContract.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContract object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/RenewalType": {
"get": {
"operationId": "GET_Account_Contract_RenewalType",
"summary": "List AccountContractRenewalType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContractRenewalType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/RenewalType/Paged": {
"get": {
"operationId": "GET_Account_Contract_RenewalType_Paged",
"summary": "List AccountContractRenewalType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContractRenewalType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/RenewalType/{id}": {
"get": {
"operationId": "GET_Account_Contract_RenewalType_id",
"summary": "Retrieve a AccountContractRenewalType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContractRenewalType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractRenewalType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/StatusType": {
"get": {
"operationId": "GET_Account_Contract_StatusType",
"summary": "List AccountContractStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContractStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Contract_StatusType",
"summary": "Create a AccountContractStatusType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountContractStatusType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountContractStatusType"
}
]
}
}
}
}
}
},
"/Account/Contract/StatusType/Paged": {
"get": {
"operationId": "GET_Account_Contract_StatusType_Paged",
"summary": "List AccountContractStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContractStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/StatusType/{id}": {
"get": {
"operationId": "GET_Account_Contract_StatusType_id",
"summary": "Retrieve a AccountContractStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContractStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Contract_StatusType_id",
"summary": "Update a AccountContractStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountContractStatusType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountContractStatusType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Contract_StatusType_id",
"summary": "Delete a AccountContractStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/Tracking/Commitment": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment",
"summary": "List AccountContractTrackingCommitment records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingCommitment"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Commitment/Paged": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment_Paged",
"summary": "List AccountContractTrackingCommitment records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingCommitment"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Commitment/{id}": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment_id",
"summary": "Retrieve a AccountContractTrackingCommitment record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContractTrackingCommitment"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractTrackingCommitment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/Tracking/Commitment/Invoice": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment_Invoice",
"summary": "List AccountContractTrackingCommitmentInvoice records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingCommitmentInvoice"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Commitment/Invoice/Paged": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment_Invoice_Paged",
"summary": "List AccountContractTrackingCommitmentInvoice records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingCommitmentInvoice"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Commitment/Invoice/{id}": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Commitment_Invoice_id",
"summary": "Retrieve a AccountContractTrackingCommitmentInvoice record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContractTrackingCommitmentInvoice"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractTrackingCommitmentInvoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Contract/Tracking/Termination": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Termination",
"summary": "List AccountContractTrackingTermination records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingTermination"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Termination/Paged": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Termination_Paged",
"summary": "List AccountContractTrackingTermination records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountContractTrackingTermination"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Contract/Tracking/Termination/{id}": {
"get": {
"operationId": "GET_Account_Contract_Tracking_Termination_id",
"summary": "Retrieve a AccountContractTrackingTermination record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountContractTrackingTermination"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountContractTrackingTermination object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package/View": {
"get": {
"operationId": "GET_Account_Package_View",
"summary": "List ViewAccountPackage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ViewAccountPackage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Package/View/Paged": {
"get": {
"operationId": "GET_Account_Package_View_Paged",
"summary": "List ViewAccountPackage records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ViewAccountPackage"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Package/View/{id}": {
"get": {
"operationId": "GET_Account_Package_View_id",
"summary": "Retrieve a ViewAccountPackage record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ViewAccountPackage"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ViewAccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package": {
"get": {
"operationId": "GET_Account_Package",
"summary": "List AccountPackage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Package",
"summary": "Create a AccountPackage record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPackage"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackage"
}
]
}
}
}
}
}
},
"/Account/Package/Paged": {
"get": {
"operationId": "GET_Account_Package_Paged",
"summary": "List AccountPackage records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Package/Paged/Detail": {
"get": {
"operationId": "GET_Account_Package_Paged_Detail",
"summary": "List AccountPackage records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Package/{id}": {
"get": {
"operationId": "GET_Account_Package_id",
"summary": "Retrieve a AccountPackage record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Package_id",
"summary": "Update a AccountPackage record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountPackage"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackage"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_Package_id",
"summary": "Patch a AccountPackage record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackage"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Package_id",
"summary": "Delete a AccountPackage record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package/{id}/Detail": {
"get": {
"operationId": "GET_Account_Package_id_Detail",
"summary": "Retrieve a AccountPackage record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package/FromCatalog": {
"post": {
"operationId": "POST_Account_Package_FromCatalog",
"summary": "Adds an AccountPackage to the Account and inherits all of the Package properties from the product catalog.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPackage"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackageFromCatalogParam"
}
]
}
}
}
}
}
},
"/Account/Package/{id}/CancelSetting": {
"post": {
"operationId": "POST_Account_Package_id_CancelSetting",
"summary": "Create a CancelSetting record for the specified AccountPackage.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CancelSetting"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Package_id_CancelSetting",
"summary": "Update a CancelSetting record for the specified AccountPackage.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a CancelSetting for AccountPackage"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CancelSetting"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Package_id_CancelSetting",
"summary": "Delete a CancelSetting record from the specified AccountPackage.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package/{id}/HasBucketedUsage": {
"get": {
"operationId": "GET_Account_Package_id_HasBucketedUsage",
"summary": "Returns a boolean value depending on whether an account package has Usage Buckets.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPackageIdHasBucketedUsageResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Package/ByExtension": {
"get": {
"operationId": "GET_Account_Package_ByExtension",
"summary": "Search account packages using extension criteria.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPackage"
}
}
}
}
]
}
}
},
"description": "List of matching account packages."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns account packages that match the supplied extension search criteria.",
"parameters": [
{
"name": "extensions",
"in": "query",
"required": false,
"description": "Extension keys to search against.",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"crmId"
]
}
},
{
"name": "extensionValue",
"in": "query",
"required": false,
"description": "Extension value to match.",
"schema": {
"type": "string",
"example": "ABC-123"
}
},
{
"name": "operator",
"in": "query",
"required": false,
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "equals"
}
}
]
}
},
"/Account/Package/StatusType": {
"get": {
"operationId": "GET_Account_Package_StatusType",
"summary": "List AccountPackageStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPackageStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Package_StatusType",
"summary": "Create a AccountPackageStatusType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPackageStatusType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackageStatusType"
}
]
}
}
}
}
}
},
"/Account/Package/StatusType/Paged": {
"get": {
"operationId": "GET_Account_Package_StatusType_Paged",
"summary": "List AccountPackageStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountPackageStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Package/StatusType/{id}": {
"get": {
"operationId": "GET_Account_Package_StatusType_id",
"summary": "Retrieve a AccountPackageStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPackageStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackageStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Package_StatusType_id",
"summary": "Update a AccountPackageStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountPackageStatusType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPackageStatusType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Package_StatusType_id",
"summary": "Delete a AccountPackageStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPackageStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Parent": {
"get": {
"operationId": "GET_Account_Parent",
"summary": "List AccountParent records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountParent"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Parent",
"summary": "Create a AccountParent record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountParent"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountParent"
}
]
}
}
}
}
}
},
"/Account/Parent/Paged": {
"get": {
"operationId": "GET_Account_Parent_Paged",
"summary": "List AccountParent records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountParent"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Parent/{id}": {
"get": {
"operationId": "GET_Account_Parent_id",
"summary": "Retrieve a AccountParent record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountParent"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountParent object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Parent_id",
"summary": "Update a AccountParent record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountParent"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountParent"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Parent_id",
"summary": "Delete a AccountParent record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountParent object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan": {
"get": {
"operationId": "GET_Account_PricePlan",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_PricePlan",
"summary": "Create a AccountPricePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPricePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
}
}
},
"/Account/PricePlan/Paged": {
"get": {
"operationId": "GET_Account_PricePlan_Paged",
"summary": "List AccountPricePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/PricePlan/Paged/Detail": {
"get": {
"operationId": "GET_Account_PricePlan_Paged_Detail",
"summary": "List AccountPricePlan records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/PricePlan/{id}": {
"get": {
"operationId": "GET_Account_PricePlan_id",
"summary": "Retrieve an account price plan by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
]
}
}
},
"description": "Account price plan."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns the specified account price plan."
},
"put": {
"operationId": "PUT_Account_PricePlan_id",
"summary": "Update a AccountPricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountPricePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_PricePlan_id",
"summary": "Patch an account price plan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Account price plan updated successfully."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Updates selected fields on the specified account price plan."
},
"delete": {
"operationId": "DELETE_Account_PricePlan_id",
"summary": "Delete a AccountPricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/{id}/Detail": {
"get": {
"operationId": "GET_Account_PricePlan_id_Detail",
"summary": "Retrieve a AccountPricePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/ActiveFor/Account/{id}": {
"get": {
"operationId": "GET_Account_PricePlan_ActiveFor_Account_id",
"summary": "Retrieve the active account price plan for an account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
]
}
}
},
"description": "Active account price plan for the account."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "effective",
"in": "query",
"required": false,
"description": "Effective date and time used to determine which account price plan is active. Defaults to the current UTC date and time when omitted.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2026-03-28T00:00:00Z"
}
}
],
"description": "Returns the account price plan active for the specified account at the supplied effective date. When the effective query parameter is omitted, the current UTC date and time is used."
}
},
"/Account/PricePlan/ActiveFor/Account/{id}/Detail": {
"get": {
"operationId": "GET_Account_PricePlan_ActiveFor_Account_id_Detail",
"summary": "Retrieve the active account price plan with detail data.",
"responses": {
"200": {
"description": "Active account price plan with detail data.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
]
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "effective",
"in": "query",
"required": false,
"description": "Effective date and time used to determine which account price plan is active. Defaults to the current UTC date and time when omitted.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2026-03-28T00:00:00Z"
}
}
],
"description": "Returns the account price plan active for the specified account at the supplied effective date, including populated detail data."
}
},
"/Account/PricePlan/{id}/Patch": {
"post": {
"operationId": "POST_Account_PricePlan_id_Patch",
"summary": "POST wrapper for patching an account price plan.",
"responses": {
"200": {
"description": "Account price plan updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountPricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Compatibility route that applies the same patch behavior as PATCH `/Account/PricePlan/{id}` for clients that can only submit POST requests."
}
},
"/Account/PricePlan/{accountPricePlanId}/PackageServicePricePlan": {
"get": {
"operationId": "GET_Account_PricePlan_accountPricePlanId_PackageServicePricePlan",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "accountPricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/{accountPricePlanId}/PackageServicePricePlan/{packageServicePricePlanId}/Pricing": {
"get": {
"operationId": "GET_Account_PricePlan_accountPricePlanId_PackageServicePricePlan_packageServicePricePlanId_Pricing",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "accountPricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/{accountPricePlanId}/PackageServicePricePlan/{packageServicePricePlanId}/UsageRateOverrides": {
"get": {
"operationId": "GET_Account_PricePlan_accountPricePlanId_PackageServicePricePlan_packageServicePricePlanId_UsageRateOverrides",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "accountPricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/{accountPricePlanId}/PackageServicePricePlan/{packageServicePricePlanId}/Discounts": {
"get": {
"operationId": "GET_Account_PricePlan_accountPricePlanId_PackageServicePricePlan_packageServicePricePlanId_Discounts",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "accountPricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/PackageServicePricePlan/{packageServicePricePlanId}/LocationGroup/{geoTreeLocationGroupId}": {
"get": {
"operationId": "GET_Account_PricePlan_PackageServicePricePlan_packageServicePricePlanId_LocationGroup_geoTreeLocationGroupId",
"summary": "List AccountPricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountPricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "geoTreeLocationGroupId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_PricePlan_PackageServicePricePlan_packageServicePricePlanId_LocationGroup_geoTreeLocationGroupId",
"summary": "Patch a AccountPricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "geoTreeLocationGroupId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/LocationGroupOverride": {
"post": {
"operationId": "POST_Account_PricePlan_LocationGroupOverride",
"summary": "Create a AccountPricePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPricePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
}
}
},
"/Account/PricePlan/PackageServicePricePlan/{packageServicePricePlanId}/LocationGroupOverrides": {
"post": {
"operationId": "POST_Account_PricePlan_PackageServicePricePlan_packageServicePricePlanId_LocationGroupOverrides",
"summary": "Create a AccountPricePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPricePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_PricePlan_PackageServicePricePlan_packageServicePricePlanId_LocationGroupOverrides",
"summary": "Patch a AccountPricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "packageServicePricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/PricePlan/{accountPricePlanId}/CustomizeLocationGroup": {
"post": {
"operationId": "POST_Account_PricePlan_accountPricePlanId_CustomizeLocationGroup",
"summary": "Create a AccountPricePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountPricePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountPricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "accountPricePlanId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/ProductCode": {
"get": {
"operationId": "GET_Account_ProductCode",
"summary": "List AccountProductCode records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountProductCode"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_ProductCode",
"summary": "Create a AccountProductCode record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountProductCode"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountProductCode"
}
]
}
}
}
}
}
},
"/Account/ProductCode/Paged": {
"get": {
"operationId": "GET_Account_ProductCode_Paged",
"summary": "List AccountProductCode records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountProductCode"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/ProductCode/{id}": {
"get": {
"operationId": "GET_Account_ProductCode_id",
"summary": "Retrieve a AccountProductCode record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountProductCode"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountProductCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_ProductCode_id",
"summary": "Update a AccountProductCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountProductCode"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountProductCode"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_ProductCode_id",
"summary": "Delete a AccountProductCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountProductCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/ProductCode/AvailableFor/Account/{id}/PackageFrequency/{packageFrequencyId}": {
"get": {
"operationId": "GET_Account_ProductCode_AvailableFor_Account_id_PackageFrequency_packageFrequencyId",
"summary": "Retrieve all the AccountProductCode objects that are available for the specified Account and PackageFrequency.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountProductCodeAvailableForResult"
}
}
},
"description": "Get a PackageFrequency by its ID based on a specified AccountProductCode"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "packageFrequencyId",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "effective",
"in": "query",
"required": false,
"description": "Effective date and time used to determine which account product codes are available. Defaults to the current UTC date and time when omitted.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2026-03-28T00:00:00Z"
}
}
]
}
},
"/Account/ProductCode/AvailableFor/Account/{id}": {
"get": {
"operationId": "GET_Account_ProductCode_AvailableFor_Account_id",
"summary": "Retrieve all AccountProductCode objects that are available for the specified Account.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountProductCodeAvailableForResult"
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "effective",
"in": "query",
"required": false,
"description": "Effective date and time used to determine which account product codes are available. Defaults to the current UTC date and time when omitted.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2026-03-28T00:00:00Z"
}
}
]
}
},
"/Account/Service": {
"get": {
"operationId": "GET_Account_Service",
"summary": "List AccountService records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_Service",
"summary": "Create a AccountService record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountService"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountService"
}
]
}
}
}
}
}
},
"/Account/Service/Paged": {
"get": {
"operationId": "GET_Account_Service_Paged",
"summary": "List AccountService records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Paged/Detail": {
"get": {
"operationId": "GET_Account_Service_Paged_Detail",
"summary": "List AccountService records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/{id}": {
"get": {
"operationId": "GET_Account_Service_id",
"summary": "Retrieve a AccountService record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountService"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_Service_id",
"summary": "Update a AccountService record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountService"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountService"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_Service_id",
"summary": "Patch a AccountService record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountService"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_Service_id",
"summary": "Delete a AccountService record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/{id}/Detail": {
"get": {
"operationId": "GET_Account_Service_id_Detail",
"summary": "Retrieve a AccountService record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountService"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/{id}/Current": {
"get": {
"operationId": "GET_Account_Service_id_Current",
"summary": "Returns the most recent status of the AccountService.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountServiceIdCurrentResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/UsageIdentifierHistory": {
"get": {
"operationId": "GET_Account_Service_UsageIdentifierHistory",
"summary": "Retrieve account services that match a search prefix parameter.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Current": {
"get": {
"operationId": "GET_Account_Service_Current",
"summary": "List AccountService records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Current/Paged": {
"get": {
"operationId": "GET_Account_Service_Current_Paged",
"summary": "List AccountService records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountService"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Current/{id}": {
"get": {
"operationId": "GET_Account_Service_Current_id",
"summary": "Retrieve a AccountService record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountService"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/Usage/Bucket": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket",
"summary": "Retrieve account service usage buckets.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
}
}
}
]
}
}
},
"description": "List of account service usage buckets."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns account service usage buckets that match the supplied query criteria."
},
"post": {
"operationId": "POST_Account_Service_Usage_Bucket",
"summary": "Create an account service usage bucket.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Account service usage bucket created successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
]
}
}
}
},
"description": "Creates a usage bucket assignment for an account service."
}
},
"/Account/Service/Usage/Bucket/Paged": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket_Paged",
"summary": "List AccountServiceUsageBucket records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Usage/Bucket/Paged/Detail": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket_Paged_Detail",
"summary": "List AccountServiceUsageBucket records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/Service/Usage/Bucket/{id}": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket_id",
"summary": "Retrieve an account service usage bucket by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
}
}
]
}
}
},
"description": "Account service usage bucket."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountServiceUsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns the specified account service usage bucket."
},
"put": {
"operationId": "PUT_Account_Service_Usage_Bucket_id",
"summary": "Update a AccountServiceUsageBucket record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountServiceUsageBucket"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_Service_Usage_Bucket_id",
"summary": "Patch an account service usage bucket.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Account service usage bucket updated successfully."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountServiceUsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Updates selected fields on the specified account service usage bucket."
},
"delete": {
"operationId": "DELETE_Account_Service_Usage_Bucket_id",
"summary": "Delete a AccountServiceUsageBucket record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountServiceUsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/Usage/Bucket/{id}/Detail": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket_id_Detail",
"summary": "Retrieve an account service usage bucket with detail data by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountServiceUsageBucket"
}
}
}
]
}
}
},
"description": "Account service usage bucket with detail data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountServiceUsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns a single account service usage bucket and includes any populated detail records."
}
},
"/Account/SharePlan": {
"get": {
"operationId": "GET_Account_SharePlan",
"summary": "List AccountSharePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSharePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Paged": {
"get": {
"operationId": "GET_Account_SharePlan_Paged",
"summary": "List AccountSharePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountSharePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/{id}": {
"get": {
"operationId": "GET_Account_SharePlan_id",
"summary": "Retrieve a AccountSharePlan record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountSharePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_SharePlan_id",
"summary": "Update a AccountSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountSharePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountSharePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_SharePlan_id",
"summary": "Patch a AccountSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountSharePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_SharePlan_id",
"summary": "Delete a AccountSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/{id}/Detail": {
"get": {
"operationId": "GET_Account_SharePlan_id_Detail",
"summary": "Retrieve a AccountSharePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountSharePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/ForAccount/{id}/Rank": {
"put": {
"operationId": "PUT_Account_SharePlan_ForAccount_id_Rank",
"summary": "Re-arrange the order of Account Share Plan Add On.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Rank for AccountSharePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountSharePlanForAccountRankParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": " When a Service / Package is part of multiple AccountSharePlans, the bucketing engine needs to know the priority of the associated buckets. The Rank defined based on the order of the AccountSharePlan will be used to identify the priority. This API is expecting all the AccountSharePlan ids of the account to be passed in order of priority."
}
},
"/Account/SharePlan/{id}/UsageBucket/{usageBucketId}/Notification": {
"get": {
"operationId": "GET_Account_SharePlan_id_UsageBucket_usageBucketId_Notification",
"summary": "Retrieve a UsageBucket record for the specified AccountSharePlan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
]
}
}
},
"description": "Get a UsageBucket by its ID based on a specified AccountSharePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "usageBucketId",
"required": true,
"description": "Unique identifier for the UsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/{id}/AddOn": {
"post": {
"operationId": "POST_Account_SharePlan_id_AddOn",
"summary": "A user friendly way to create an Account Share Plan Add On.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountSharePlanAddOnParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": " Sample shows adding a recurring Account Share Plan Add On with a price override."
},
"get": {
"operationId": "GET_Account_SharePlan_id_AddOn",
"summary": "List AddOn records for the specified AccountSharePlan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Account_SharePlan_id_AddOn",
"summary": "Patch a AccountSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountSharePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/{id}/ProductCode": {
"post": {
"operationId": "POST_Account_SharePlan_id_ProductCode",
"summary": "Attach a product code to an account share plan.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Account share plan product code created successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSharePlanProductCode"
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Creates a product code assignment for the specified account share plan."
}
},
"/Account/SharePlan/{id}/ProductCode/{productCode}": {
"patch": {
"operationId": "PATCH_Account_SharePlan_id_ProductCode_productCode",
"summary": "Patch product-code customization on an account share plan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Account share plan product-code customization updated successfully."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSharePlanProductCodePatch"
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "productCode",
"required": true,
"description": "Product code assigned to the account share plan.",
"schema": {
"type": "string",
"example": "PLAN-ADDON-001"
},
"in": "path"
}
],
"description": "Updates product-code customization for the specified account share plan and product code."
},
"get": {
"operationId": "GET_Account_SharePlan_id_ProductCode_productCode",
"summary": "Retrieve an account share plan by attached product code.",
"responses": {
"200": {
"description": "Account share plan associated with the product code.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountSharePlan"
}
}
}
]
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "productCode",
"required": true,
"description": "Unique identifier for the ProductCode object.",
"schema": {
"type": "string"
},
"in": "path"
}
],
"description": "Returns the account share plan associated with the specified product code."
}
},
"/Account/SharePlan/{id}/AttachedProductCode": {
"get": {
"operationId": "GET_Account_SharePlan_id_AttachedProductCode",
"summary": "List AttachedProductCode records for the specified AccountSharePlan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachedProductCode"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/{id}/AvailableFor/ProductCode": {
"get": {
"operationId": "GET_Account_SharePlan_id_AvailableFor_ProductCode",
"summary": "Retrieve product codes available for an account share plan.",
"responses": {
"200": {
"description": "List of product codes available for the account share plan.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSharePlanProductCodeAvailableFor"
}
}
}
}
]
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "productCodePrefix",
"in": "query",
"required": false,
"description": "Optional prefix used to filter available product codes.",
"schema": {
"type": "string",
"example": "DU-"
}
}
],
"description": "Returns product codes that can be attached to the specified account share plan. Use the optional productCodePrefix query parameter to narrow the results."
}
},
"/Account/SharePlan/{id}/ProductCode/{accountProductCodeName}": {
"delete": {
"operationId": "DELETE_Account_SharePlan_id_ProductCode_accountProductCodeName",
"summary": "Delete a ProductCode/{accountProductCodeName} record from the specified AccountSharePlan.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "accountProductCodeName",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/Account/SharePlan/BucketUsage/ByService": {
"get": {
"operationId": "GET_Account_SharePlan_BucketUsage_ByService",
"summary": "List ViewSharePlanBucketUsageByService records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ViewSharePlanBucketUsageByService"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/BucketUsage/ByService/Paged": {
"get": {
"operationId": "GET_Account_SharePlan_BucketUsage_ByService_Paged",
"summary": "List ViewSharePlanBucketUsageByService records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ViewSharePlanBucketUsageByService"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Contribution": {
"get": {
"operationId": "GET_Account_SharePlan_Contribution",
"summary": "List AccountSharePlanContribution records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSharePlanContribution"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Contribution/Paged": {
"get": {
"operationId": "GET_Account_SharePlan_Contribution_Paged",
"summary": "List AccountSharePlanContribution records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountSharePlanContribution"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Contribution/{id}": {
"get": {
"operationId": "GET_Account_SharePlan_Contribution_id",
"summary": "Retrieve a AccountSharePlanContribution record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountSharePlanContribution"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlanContribution object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/SharePlan/Participation": {
"get": {
"operationId": "GET_Account_SharePlan_Participation",
"summary": "List AccountSharePlanParticipation records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSharePlanParticipation"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Participation/Paged": {
"get": {
"operationId": "GET_Account_SharePlan_Participation_Paged",
"summary": "List AccountSharePlanParticipation records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountSharePlanParticipation"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/SharePlan/Participation/{id}": {
"get": {
"operationId": "GET_Account_SharePlan_Participation_id",
"summary": "Retrieve a AccountSharePlanParticipation record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountSharePlanParticipation"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountSharePlanParticipation object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/StatusType": {
"get": {
"operationId": "GET_Account_StatusType",
"summary": "List AccountStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_StatusType",
"summary": "Create a AccountStatusType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountStatusType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountStatusType"
}
]
}
}
}
}
}
},
"/Account/StatusType/Paged": {
"get": {
"operationId": "GET_Account_StatusType_Paged",
"summary": "List AccountStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/StatusType/{id}": {
"get": {
"operationId": "GET_Account_StatusType_id",
"summary": "Retrieve a AccountStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_StatusType_id",
"summary": "Update a AccountStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountStatusType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountStatusType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_StatusType_id",
"summary": "Delete a AccountStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/TaxCategory": {
"get": {
"operationId": "GET_Account_TaxCategory",
"summary": "List AccountTaxCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountTaxCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Account_TaxCategory",
"summary": "Create a AccountTaxCategory record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountTaxCategory"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountTaxCategory"
}
]
}
}
}
}
}
},
"/Account/TaxCategory/Paged": {
"get": {
"operationId": "GET_Account_TaxCategory_Paged",
"summary": "List AccountTaxCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountTaxCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Account/TaxCategory/{id}": {
"get": {
"operationId": "GET_Account_TaxCategory_id",
"summary": "Retrieve a AccountTaxCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountTaxCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountTaxCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Account_TaxCategory_id",
"summary": "Update a AccountTaxCategory record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountTaxCategory"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountTaxCategory"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Account_TaxCategory_id",
"summary": "Delete a AccountTaxCategory record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountTaxCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Forget": {
"post": {
"operationId": "POST_Account_Forget",
"summary": "Create a AccountForget record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountForget"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountForget"
}
]
}
}
}
}
}
},
"/AccountInvoiceDiscountTracking": {
"get": {
"operationId": "GET_AccountInvoiceDiscountTracking",
"summary": "List AccountInvoiceDiscountTracking records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountInvoiceDiscountTracking"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_AccountInvoiceDiscountTracking",
"summary": "Create a AccountInvoiceDiscountTracking record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountInvoiceDiscountTracking"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountInvoiceDiscountTracking"
}
]
}
}
}
}
}
},
"/AccountInvoiceDiscountTracking/Paged": {
"get": {
"operationId": "GET_AccountInvoiceDiscountTracking_Paged",
"summary": "List AccountInvoiceDiscountTracking records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountInvoiceDiscountTracking"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AccountInvoiceDiscountTracking/{id}": {
"get": {
"operationId": "GET_AccountInvoiceDiscountTracking_id",
"summary": "Retrieve a AccountInvoiceDiscountTracking record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountInvoiceDiscountTracking"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountInvoiceDiscountTracking object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_AccountInvoiceDiscountTracking_id",
"summary": "Update a AccountInvoiceDiscountTracking record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountInvoiceDiscountTracking"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountInvoiceDiscountTracking"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_AccountInvoiceDiscountTracking_id",
"summary": "Delete a AccountInvoiceDiscountTracking record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountInvoiceDiscountTracking object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/AccountTaxExemptLevel": {
"get": {
"operationId": "GET_AccountTaxExemptLevel",
"summary": "List AccountTaxExemptLevel records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountTaxExemptLevel"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AccountTaxExemptLevel/Paged": {
"get": {
"operationId": "GET_AccountTaxExemptLevel_Paged",
"summary": "List AccountTaxExemptLevel records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountTaxExemptLevel"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AccountTaxExemptLevel/{id}": {
"get": {
"operationId": "GET_AccountTaxExemptLevel_id",
"summary": "Retrieve a AccountTaxExemptLevel record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountTaxExemptLevel"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountTaxExemptLevel object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/AccountType": {
"get": {
"operationId": "GET_AccountType",
"summary": "List AccountType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_AccountType",
"summary": "Create a AccountType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountType"
}
]
}
}
}
}
}
},
"/AccountType/Paged": {
"get": {
"operationId": "GET_AccountType_Paged",
"summary": "List AccountType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AccountType/{id}": {
"get": {
"operationId": "GET_AccountType_id",
"summary": "Retrieve a AccountType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_AccountType_id",
"summary": "Update a AccountType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_AccountType_id",
"summary": "Delete a AccountType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/AccountsReceivable/Terms": {
"get": {
"operationId": "GET_AccountsReceivable_Terms",
"summary": "List AccountsReceivableTerms records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountsReceivableTerms"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_AccountsReceivable_Terms",
"summary": "Create a AccountsReceivableTerms record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AccountsReceivableTerms"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountsReceivableTerms"
}
]
}
}
}
}
}
},
"/AccountsReceivable/Terms/Paged": {
"get": {
"operationId": "GET_AccountsReceivable_Terms_Paged",
"summary": "List AccountsReceivableTerms records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AccountsReceivableTerms"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AccountsReceivable/Terms/{id}": {
"get": {
"operationId": "GET_AccountsReceivable_Terms_id",
"summary": "Retrieve a AccountsReceivableTerms record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountsReceivableTerms"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountsReceivableTerms object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_AccountsReceivable_Terms_id",
"summary": "Update a AccountsReceivableTerms record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a AccountsReceivableTerms"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AccountsReceivableTerms"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_AccountsReceivable_Terms_id",
"summary": "Delete a AccountsReceivableTerms record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AccountsReceivableTerms object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Adyen/MerchantAccount/PaymentGateway/{paymentGatewayId}": {
"get": {
"operationId": "GET_Adyen_MerchantAccount_PaymentGateway_paymentGatewayId",
"summary": "List AdyenMerchantAccount records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdyenMerchantAccount"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "paymentGatewayId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Adyen/MerchantAccount/PaymentGateway/{paymentGatewayId}/Sync": {
"post": {
"operationId": "POST_Adyen_MerchantAccount_PaymentGateway_paymentGatewayId_Sync",
"summary": "Synchronize Adyen merchant accounts for the specified payment gateway.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Merchant account synchronization request created successfully."
}
},
"parameters": [
{
"name": "paymentGatewayId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Synchronizes Adyen merchant accounts for the specified payment gateway."
}
},
"/ApplicationVersion": {
"get": {
"operationId": "GET_ApplicationVersion",
"summary": "Retrieve the current system version number.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationVersionResults"
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AuthenticationType": {
"get": {
"operationId": "GET_AuthenticationType",
"summary": "List AuthenticationType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthenticationType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AuthenticationType/Paged": {
"get": {
"operationId": "GET_AuthenticationType_Paged",
"summary": "List AuthenticationType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/AuthenticationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/AuthenticationType/{id}": {
"get": {
"operationId": "GET_AuthenticationType_id",
"summary": "Retrieve a AuthenticationType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AuthenticationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AuthenticationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillCancelOptionType": {
"get": {
"operationId": "GET_BillCancelOptionType",
"summary": "List BillCancelOptionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillCancelOptionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillCancelOptionType/Paged": {
"get": {
"operationId": "GET_BillCancelOptionType_Paged",
"summary": "List BillCancelOptionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillCancelOptionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillCancelOptionType/{id}": {
"get": {
"operationId": "GET_BillCancelOptionType_id",
"summary": "Retrieve a BillCancelOptionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillCancelOptionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillCancelOptionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillGroup": {
"get": {
"operationId": "GET_BillGroup",
"summary": "List BillGroup records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillGroup"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_BillGroup",
"summary": "Create a BillGroup record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a BillGroup"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillGroup"
}
]
}
}
}
}
}
},
"/BillGroup/Paged": {
"get": {
"operationId": "GET_BillGroup_Paged",
"summary": "List BillGroup records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillGroup/Paged/Detail": {
"get": {
"operationId": "GET_BillGroup_Paged_Detail",
"summary": "List BillGroup records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillGroup/{id}": {
"get": {
"operationId": "GET_BillGroup_id",
"summary": "Retrieve a BillGroup record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillGroup"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_BillGroup_id",
"summary": "Update a BillGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a BillGroup"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_BillGroup_id",
"summary": "Patch a BillGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_BillGroup_id",
"summary": "Delete a BillGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillGroup/{id}/Detail": {
"get": {
"operationId": "GET_BillGroup_id_Detail",
"summary": "Retrieve a BillGroup record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillGroup"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillGroup/AccountExclude": {
"get": {
"operationId": "GET_BillGroup_AccountExclude",
"summary": "List BillGroupAccountExclude records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillGroupAccountExclude"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_BillGroup_AccountExclude",
"summary": "Create a BillGroupAccountExclude record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a BillGroupAccountExclude"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillGroupAccountExclude"
}
]
}
}
}
}
}
},
"/BillGroup/AccountExclude/Paged": {
"get": {
"operationId": "GET_BillGroup_AccountExclude_Paged",
"summary": "List BillGroupAccountExclude records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillGroupAccountExclude"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillGroup/AccountExclude/{id}": {
"get": {
"operationId": "GET_BillGroup_AccountExclude_id",
"summary": "Retrieve a BillGroupAccountExclude record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillGroupAccountExclude"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroupAccountExclude object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_BillGroup_AccountExclude_id",
"summary": "Update a BillGroupAccountExclude record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a BillGroupAccountExclude"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillGroupAccountExclude"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_BillGroup_AccountExclude_id",
"summary": "Delete a BillGroupAccountExclude record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillGroupAccountExclude object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun": {
"get": {
"operationId": "GET_BillRun",
"summary": "List BillRun records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRun"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_BillRun",
"summary": "Create a BillRun record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a BillRun"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillRun"
}
]
}
}
}
}
}
},
"/BillRun/Paged": {
"get": {
"operationId": "GET_BillRun_Paged",
"summary": "List BillRun records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRun"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/Paged/Detail": {
"get": {
"operationId": "GET_BillRun_Paged_Detail",
"summary": "List BillRun records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRun"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/{id}": {
"get": {
"operationId": "GET_BillRun_id",
"summary": "Retrieve a BillRun record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRun"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRun object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_BillRun_id",
"summary": "Update a BillRun record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a BillRun"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillRun"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_BillRun_id",
"summary": "Patch a BillRun record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillRun"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRun object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_BillRun_id",
"summary": "Delete a BillRun record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRun object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/{id}/Detail": {
"get": {
"operationId": "GET_BillRun_id_Detail",
"summary": "Retrieve a BillRun record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRun"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRun object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/History": {
"get": {
"operationId": "GET_BillRun_History",
"summary": "List BillRunHistory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunHistory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/History/Paged": {
"get": {
"operationId": "GET_BillRun_History_Paged",
"summary": "List BillRunHistory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunHistory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/History/{id}": {
"get": {
"operationId": "GET_BillRun_History_id",
"summary": "Retrieve a BillRunHistory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunHistory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/History/{id}/Detail": {
"get": {
"operationId": "GET_BillRun_History_id_Detail",
"summary": "Retrieve a BillRunHistory record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunHistory"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/History/{id}/Recovery": {
"post": {
"operationId": "POST_BillRun_History_id_Recovery",
"summary": "Create a bill run recovery for the specified bill run history record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Recovery bill run request processed."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Creates a recovery bill run for the specified bill run history record."
}
},
"/BillRun/History/{id}/DataExport": {
"get": {
"operationId": "GET_BillRun_History_id_DataExport",
"summary": "List DataExport records for the specified BillRunHistory.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataExport"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/History/{id}/DataExport/Paged": {
"get": {
"operationId": "GET_BillRun_History_id_DataExport_Paged",
"summary": "List DataExport records for the specified BillRunHistory with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DataExport"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/Schedule": {
"get": {
"operationId": "GET_BillRun_Schedule",
"summary": "List BillRunSchedule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunSchedule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": " NOTE: This end point is no longer supported in v4 of the API."
}
},
"/BillRun/Schedule/Paged": {
"get": {
"operationId": "GET_BillRun_Schedule_Paged",
"summary": "List BillRunSchedule records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunSchedule"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": " NOTE: This end point is no longer supported in v4 of the API."
}
},
"/BillRun/Schedule/{id}": {
"get": {
"operationId": "GET_BillRun_Schedule_id",
"summary": "Retrieve a BillRunSchedule record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunSchedule"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunSchedule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": " NOTE: This end point is no longer supported in v4 of the API."
}
},
"/BillRun/Schedule/{id}/Cancel": {
"post": {
"operationId": "POST_BillRun_Schedule_id_Cancel",
"summary": "Cancel the specified bill run schedule.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Bill run schedule cancelled successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunSchedule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Cancels the specified bill run schedule."
}
},
"/BillRun/Schedule/OneTime": {
"post": {
"operationId": "POST_BillRun_Schedule_OneTime",
"summary": "Create a new One Time BillRunSchedule object.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a BillRunSchedule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BillRunScheduleOneTimeParam"
}
]
}
}
}
}
}
},
"/BillRun/Schedule/StatusType": {
"get": {
"operationId": "GET_BillRun_Schedule_StatusType",
"summary": "List BillRunScheduleStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunScheduleStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/Schedule/StatusType/Paged": {
"get": {
"operationId": "GET_BillRun_Schedule_StatusType_Paged",
"summary": "List BillRunScheduleStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunScheduleStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/Schedule/StatusType/{id}": {
"get": {
"operationId": "GET_BillRun_Schedule_StatusType_id",
"summary": "Retrieve a BillRunScheduleStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunScheduleStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunScheduleStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/StatusType": {
"get": {
"operationId": "GET_BillRun_StatusType",
"summary": "List BillRunStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/StatusType/Paged": {
"get": {
"operationId": "GET_BillRun_StatusType_Paged",
"summary": "List BillRunStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/StatusType/{id}": {
"get": {
"operationId": "GET_BillRun_StatusType_id",
"summary": "Retrieve a BillRunStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRun/StepType": {
"get": {
"operationId": "GET_BillRun_StepType",
"summary": "List BillRunStepType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunStepType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/StepType/Paged": {
"get": {
"operationId": "GET_BillRun_StepType_Paged",
"summary": "List BillRunStepType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunStepType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRun/StepType/{id}": {
"get": {
"operationId": "GET_BillRun_StepType_id",
"summary": "Retrieve a BillRunStepType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunStepType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunStepType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/BillRunType": {
"get": {
"operationId": "GET_BillRunType",
"summary": "List BillRunType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillRunType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRunType/Paged": {
"get": {
"operationId": "GET_BillRunType_Paged",
"summary": "List BillRunType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/BillRunType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/BillRunType/{id}": {
"get": {
"operationId": "GET_BillRunType_id",
"summary": "Retrieve a BillRunType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/BillRunType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the BillRunType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CardType": {
"get": {
"operationId": "GET_CardType",
"summary": "List CardType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/CardType/Paged": {
"get": {
"operationId": "GET_CardType_Paged",
"summary": "List CardType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CardType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/CardType/{id}": {
"get": {
"operationId": "GET_CardType_id",
"summary": "Retrieve a CardType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CardType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CardType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CollectionType": {
"get": {
"operationId": "GET_CollectionType",
"summary": "List CollectionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/CollectionType/Paged": {
"get": {
"operationId": "GET_CollectionType_Paged",
"summary": "List CollectionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CollectionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/CollectionType/{id}": {
"get": {
"operationId": "GET_CollectionType_id",
"summary": "Retrieve a CollectionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CollectionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CollectionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/Group/ConditionFieldType": {
"get": {
"operationId": "GET_Usage_Rate_Group_ConditionFieldType",
"summary": "List ConditionFieldType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionFieldType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Group/ConditionFieldType/Paged": {
"get": {
"operationId": "GET_Usage_Rate_Group_ConditionFieldType_Paged",
"summary": "List ConditionFieldType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ConditionFieldType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Group/ConditionFieldType/{id}": {
"get": {
"operationId": "GET_Usage_Rate_Group_ConditionFieldType_id",
"summary": "Retrieve a ConditionFieldType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ConditionFieldType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ConditionFieldType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contact": {
"get": {
"operationId": "GET_Contact",
"summary": "List Contact records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Contact",
"summary": "Create a Contact record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Contact"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
}
}
},
"/Contact/Paged": {
"get": {
"operationId": "GET_Contact_Paged",
"summary": "List Contact records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contact/Paged/Detail": {
"get": {
"operationId": "GET_Contact_Paged_Detail",
"summary": "List Contact records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contact/{id}": {
"get": {
"operationId": "GET_Contact_id",
"summary": "Retrieve a Contact record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Contact"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Contact object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Contact_id",
"summary": "Update a Contact record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Contact"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Contact_id",
"summary": "Patch a Contact record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Contact object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contact/{id}/Detail": {
"get": {
"operationId": "GET_Contact_id_Detail",
"summary": "Retrieve a Contact record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Contact"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Contact object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ContactPointType": {
"get": {
"operationId": "GET_ContactPointType",
"summary": "List ContactPointType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPointType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactPointType/Paged": {
"get": {
"operationId": "GET_ContactPointType_Paged",
"summary": "List ContactPointType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContactPointType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactPointType/{id}": {
"get": {
"operationId": "GET_ContactPointType_id",
"summary": "Retrieve a ContactPointType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContactPointType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactPointType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ContactType": {
"get": {
"operationId": "GET_ContactType",
"summary": "List ContactType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_ContactType",
"summary": "Create a ContactType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ContactType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContactType"
}
]
}
}
}
}
}
},
"/ContactType/Paged": {
"get": {
"operationId": "GET_ContactType_Paged",
"summary": "List ContactType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContactType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactType/Paged/Detail": {
"get": {
"operationId": "GET_ContactType_Paged_Detail",
"summary": "List ContactType records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContactType"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactType/{id}": {
"get": {
"operationId": "GET_ContactType_id",
"summary": "Retrieve a ContactType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContactType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_ContactType_id",
"summary": "Update a ContactType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ContactType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContactType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_ContactType_id",
"summary": "Patch a ContactType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContactType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_ContactType_id",
"summary": "Delete a ContactType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ContactType/{id}/Detail": {
"get": {
"operationId": "GET_ContactType_id_Detail",
"summary": "Retrieve a ContactType record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContactType"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ContactType/Type": {
"get": {
"operationId": "GET_ContactType_Type",
"summary": "List ContactTypeType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactTypeType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactType/Type/Paged": {
"get": {
"operationId": "GET_ContactType_Type_Paged",
"summary": "List ContactTypeType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContactTypeType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ContactType/Type/{id}": {
"get": {
"operationId": "GET_ContactType_Type_id",
"summary": "Retrieve a ContactTypeType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContactTypeType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContactTypeType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/Commitment": {
"get": {
"operationId": "GET_Contract_Commitment",
"summary": "List ContractCommitment records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractCommitment"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Contract_Commitment",
"summary": "Create a ContractCommitment record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ContractCommitment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractCommitment"
}
]
}
}
}
}
}
},
"/Contract/Commitment/Paged": {
"get": {
"operationId": "GET_Contract_Commitment_Paged",
"summary": "List ContractCommitment records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractCommitment"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Commitment/Paged/Detail": {
"get": {
"operationId": "GET_Contract_Commitment_Paged_Detail",
"summary": "List ContractCommitment records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractCommitment"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Commitment/{id}": {
"get": {
"operationId": "GET_Contract_Commitment_id",
"summary": "Retrieve a ContractCommitment record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractCommitment"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Contract_Commitment_id",
"summary": "Update a ContractCommitment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ContractCommitment"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractCommitment"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Contract_Commitment_id",
"summary": "Patch a ContractCommitment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractCommitment"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Contract_Commitment_id",
"summary": "Delete a ContractCommitment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/Commitment/{id}/Detail": {
"get": {
"operationId": "GET_Contract_Commitment_id_Detail",
"summary": "Retrieve a ContractCommitment record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractCommitment"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/CommitmentType": {
"get": {
"operationId": "GET_Contract_CommitmentType",
"summary": "List ContractCommitmentType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractCommitmentType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/CommitmentType/Paged": {
"get": {
"operationId": "GET_Contract_CommitmentType_Paged",
"summary": "List ContractCommitmentType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractCommitmentType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/CommitmentType/{id}": {
"get": {
"operationId": "GET_Contract_CommitmentType_id",
"summary": "Retrieve a ContractCommitmentType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractCommitmentType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitmentType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/Termination": {
"get": {
"operationId": "GET_Contract_Termination",
"summary": "List ContractTermination records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractTermination"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Contract_Termination",
"summary": "Create a ContractTermination record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ContractTermination"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractTermination"
}
]
}
}
}
}
}
},
"/Contract/Termination/Paged": {
"get": {
"operationId": "GET_Contract_Termination_Paged",
"summary": "List ContractTermination records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractTermination"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Termination/Paged/Detail": {
"get": {
"operationId": "GET_Contract_Termination_Paged_Detail",
"summary": "List ContractTermination records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractTermination"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Termination/{id}": {
"get": {
"operationId": "GET_Contract_Termination_id",
"summary": "Retrieve a ContractTermination record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractTermination"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractTermination object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Contract_Termination_id",
"summary": "Update a ContractTermination record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ContractTermination"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractTermination"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Contract_Termination_id",
"summary": "Patch a ContractTermination record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContractTermination"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractTermination object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Contract_Termination_id",
"summary": "Delete a ContractTermination record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractTermination object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/Termination/{id}/Detail": {
"get": {
"operationId": "GET_Contract_Termination_id_Detail",
"summary": "Retrieve a ContractTermination record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractTermination"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractTermination object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Contract/Commitment/PenaltyChargeType": {
"get": {
"operationId": "GET_Contract_Commitment_PenaltyChargeType",
"summary": "List ContractCommitmentPenaltyChargeType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContractCommitmentPenaltyChargeType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Commitment/PenaltyChargeType/Paged": {
"get": {
"operationId": "GET_Contract_Commitment_PenaltyChargeType_Paged",
"summary": "List ContractCommitmentPenaltyChargeType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ContractCommitmentPenaltyChargeType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Contract/Commitment/PenaltyChargeType/{id}": {
"get": {
"operationId": "GET_Contract_Commitment_PenaltyChargeType_id",
"summary": "Retrieve a ContractCommitmentPenaltyChargeType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ContractCommitmentPenaltyChargeType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ContractCommitmentPenaltyChargeType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CountingRule": {
"get": {
"operationId": "GET_CountingRule",
"summary": "List CountingRule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountingRule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_CountingRule",
"summary": "Create a CountingRule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CountingRule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CountingRule"
}
]
}
}
}
}
}
},
"/CountingRule/Paged": {
"get": {
"operationId": "GET_CountingRule_Paged",
"summary": "List CountingRule records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CountingRule"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/CountingRule/{id}": {
"get": {
"operationId": "GET_CountingRule_id",
"summary": "Retrieve a CountingRule record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CountingRule"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountingRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_CountingRule_id",
"summary": "Update a CountingRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a CountingRule"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CountingRule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_CountingRule_id",
"summary": "Patch a CountingRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CountingRule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountingRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_CountingRule_id",
"summary": "Delete a CountingRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountingRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CountingRule/{id}/Detail": {
"get": {
"operationId": "GET_CountingRule_id_Detail",
"summary": "Retrieve a CountingRule record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CountingRule"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountingRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Country": {
"get": {
"operationId": "GET_Country",
"summary": "List Country records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Country"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Country",
"summary": "Create a Country record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Country"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
}
]
}
}
}
}
}
},
"/Country/Paged": {
"get": {
"operationId": "GET_Country_Paged",
"summary": "List Country records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Country"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Country/Paged/Detail": {
"get": {
"operationId": "GET_Country_Paged_Detail",
"summary": "List Country records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Country"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Country/{id}": {
"get": {
"operationId": "GET_Country_id",
"summary": "Retrieve a Country record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Country"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Country object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Country_id",
"summary": "Update a Country record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Country"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Country_id",
"summary": "Patch a Country record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Country"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Country object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Country_id",
"summary": "Delete a Country record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Country object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Country/{id}/Detail": {
"get": {
"operationId": "GET_Country_id_Detail",
"summary": "Retrieve a Country record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Country"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Country object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Country/AddressFormat": {
"get": {
"operationId": "GET_Country_AddressFormat",
"summary": "List CountryAddressFormat records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryAddressFormat"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Country_AddressFormat",
"summary": "Create a CountryAddressFormat record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CountryAddressFormat"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CountryAddressFormat"
}
]
}
}
}
}
}
},
"/Country/AddressFormat/Paged": {
"get": {
"operationId": "GET_Country_AddressFormat_Paged",
"summary": "List CountryAddressFormat records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CountryAddressFormat"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Country/AddressFormat/{id}": {
"get": {
"operationId": "GET_Country_AddressFormat_id",
"summary": "Retrieve a CountryAddressFormat record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CountryAddressFormat"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountryAddressFormat object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Country_AddressFormat_id",
"summary": "Update a CountryAddressFormat record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a CountryAddressFormat"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CountryAddressFormat"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Country_AddressFormat_id",
"summary": "Delete a CountryAddressFormat record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CountryAddressFormat object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Credit/Item": {
"get": {
"operationId": "GET_Credit_Item",
"summary": "List CreditItem records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditItem"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Credit/Item/Paged": {
"get": {
"operationId": "GET_Credit_Item_Paged",
"summary": "List CreditItem records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CreditItem"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Credit/Item/{id}": {
"get": {
"operationId": "GET_Credit_Item_id",
"summary": "Retrieve a CreditItem record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CreditItem"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Credit/Note": {
"get": {
"operationId": "GET_Credit_Note",
"summary": "List CreditNote records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Credit/Note/Paged": {
"get": {
"operationId": "GET_Credit_Note_Paged",
"summary": "List CreditNote records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Credit/Note/Paged/Detail": {
"get": {
"operationId": "GET_Credit_Note_Paged_Detail",
"summary": "List CreditNote records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Credit/Note/{id}": {
"get": {
"operationId": "GET_Credit_Note_id",
"summary": "Retrieve a CreditNote record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditNote object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Credit_Note_id",
"summary": "Delete a CreditNote record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditNote object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Credit/Note/{id}/Detail": {
"get": {
"operationId": "GET_Credit_Note_id_Detail",
"summary": "Retrieve a CreditNote record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditNote object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Credit/Note/Send": {
"post": {
"operationId": "POST_Credit_Note_Send",
"summary": "Delivers the specified CreditNote to the proper recipient.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CreditNote"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreditNoteSendParam"
}
]
}
}
}
}
}
},
"/Credit/Note/{id}/Send": {
"post": {
"operationId": "POST_Credit_Note_id_Send",
"summary": "Create a Send record for the specified CreditNote.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Send"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditNote object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Credit/Note/OnDemandRender": {
"post": {
"operationId": "POST_Credit_Note_OnDemandRender",
"summary": "Imediately initiates the rendering of a specified CreditNote.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CreditNote"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreditNote"
}
]
}
}
}
}
}
},
"/Credit/Note/{id}/Download": {
"get": {
"operationId": "GET_Credit_Note_id_Download",
"summary": "Retrieve the rendered PDF for a credit note.",
"responses": {
"200": {
"description": "Rendered credit note download payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNoteIdDownloadResult"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CreditNote object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "linkOnly",
"in": "query",
"required": false,
"description": "When true, returns the download link metadata without embedding the base64 PDF content.",
"schema": {
"type": "boolean",
"example": false
}
}
],
"description": "Returns the rendered credit note PDF content and download link for the specified credit note. Use the optional linkOnly query parameter to return only the download link metadata."
}
},
"/Currency": {
"get": {
"operationId": "GET_Currency",
"summary": "List Currency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Currency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Currency",
"summary": "Create a Currency record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Currency"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Currency"
}
]
}
}
}
}
}
},
"/Currency/Paged": {
"get": {
"operationId": "GET_Currency_Paged",
"summary": "List Currency records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Currency"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Currency/{id}": {
"get": {
"operationId": "GET_Currency_id",
"summary": "Retrieve a Currency record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Currency"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Currency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Currency_id",
"summary": "Update a Currency record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Currency"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Currency"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Currency_id",
"summary": "Delete a Currency record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Currency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Currency/Exchange": {
"get": {
"operationId": "GET_Currency_Exchange",
"summary": "List CurrencyExchange records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyExchange"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Currency_Exchange",
"summary": "Create a CurrencyExchange record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CurrencyExchange"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyExchange"
}
]
}
}
}
}
}
},
"/Currency/Exchange/Paged": {
"get": {
"operationId": "GET_Currency_Exchange_Paged",
"summary": "List CurrencyExchange records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CurrencyExchange"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Currency/Exchange/Paged/Detail": {
"get": {
"operationId": "GET_Currency_Exchange_Paged_Detail",
"summary": "List CurrencyExchange records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CurrencyExchange"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Currency/Exchange/{id}": {
"get": {
"operationId": "GET_Currency_Exchange_id",
"summary": "Retrieve a CurrencyExchange record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CurrencyExchange"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Currency_Exchange_id",
"summary": "Update a CurrencyExchange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a CurrencyExchange"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyExchange"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Currency_Exchange_id",
"summary": "Patch a CurrencyExchange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyExchange"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Currency_Exchange_id",
"summary": "Delete a CurrencyExchange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Currency/Exchange/{id}/Detail": {
"get": {
"operationId": "GET_Currency_Exchange_id_Detail",
"summary": "Retrieve a CurrencyExchange record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CurrencyExchange"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Currency/Exchange/Detail": {
"get": {
"operationId": "GET_Currency_Exchange_Detail",
"summary": "List CurrencyExchangeDetail records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyExchangeDetail"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Currency_Exchange_Detail",
"summary": "Create a CurrencyExchangeDetail record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a CurrencyExchangeDetail"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyExchangeDetail"
}
]
}
}
}
}
}
},
"/Currency/Exchange/Detail/Paged": {
"get": {
"operationId": "GET_Currency_Exchange_Detail_Paged",
"summary": "List CurrencyExchangeDetail records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CurrencyExchangeDetail"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Currency/Exchange/Detail/{id}": {
"get": {
"operationId": "GET_Currency_Exchange_Detail_id",
"summary": "Retrieve a CurrencyExchangeDetail record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CurrencyExchangeDetail"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchangeDetail object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Currency_Exchange_Detail_id",
"summary": "Update a CurrencyExchangeDetail record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a CurrencyExchangeDetail"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CurrencyExchangeDetail"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Currency_Exchange_Detail_id",
"summary": "Delete a CurrencyExchangeDetail record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CurrencyExchangeDetail object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/{id}/Paged": {
"get": {
"operationId": "GET_CustomDataSource_id_Paged",
"summary": "Retrieve all the data from the Custom Data Source in a paged fashion by specifying the {id} of the data source.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomDataSourcePagedResult"
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/{id}/Metadata": {
"get": {
"operationId": "GET_CustomDataSource_id_Metadata",
"summary": "List Metadata records for the specified CustomDataSource.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Metadata"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/{id}/Metadata/sql": {
"get": {
"operationId": "GET_CustomDataSource_id_Metadata_sql",
"summary": "List Metadata/sql records for the specified CustomDataSource.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataSql"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/{id}": {
"get": {
"operationId": "GET_CustomDataSource_id",
"summary": "Retrieve a CustomDataSource record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CustomDataSource"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/ByConnection/{id}": {
"get": {
"operationId": "GET_CustomDataSource_ByConnection_id",
"summary": "Retrieve a CustomDataSource record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CustomDataSource"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/CustomDataSource/ByConnection/{id}/Paged": {
"get": {
"operationId": "GET_CustomDataSource_ByConnection_id_Paged",
"summary": "List / records for the specified CustomDataSource with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CustomDataSource"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the CustomDataSource object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DailyUsageRatedException": {
"get": {
"operationId": "GET_DailyUsageRatedException",
"summary": "List DailyUsageRatedException records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DailyUsageRatedException"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DailyUsageRatedException/Paged": {
"get": {
"operationId": "GET_DailyUsageRatedException_Paged",
"summary": "List DailyUsageRatedException records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DailyUsageRatedException"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DailyUsageSummary/ByAccountService/Paged": {
"get": {
"operationId": "GET_DailyUsageSummary_ByAccountService_Paged",
"summary": "List ViewUDRDailyAggregateUsage records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ViewUDRDailyAggregateUsage"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataExport": {
"get": {
"operationId": "GET_DataExport",
"summary": "List DataExport records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataExport"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataExport/Paged": {
"get": {
"operationId": "GET_DataExport_Paged",
"summary": "List DataExport records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DataExport"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataExport/{id}": {
"get": {
"operationId": "GET_DataExport_id",
"summary": "Retrieve a DataExport record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataExport"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataExport object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataExport/{id}/TriggerExport": {
"post": {
"operationId": "POST_DataExport_id_TriggerExport",
"summary": "Create a TriggerExport record for the specified DataExport.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TriggerExport"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataExport object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataExport/History": {
"get": {
"operationId": "GET_DataExport_History",
"summary": "List DataExportHistory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataExportHistory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataExport/History/Paged": {
"get": {
"operationId": "GET_DataExport_History_Paged",
"summary": "List DataExportHistory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DataExportHistory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataExport/History/{id}": {
"get": {
"operationId": "GET_DataExport_History_id",
"summary": "Retrieve a DataExportHistory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataExportHistory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataExportHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataExport/History/{id}/Cancel": {
"post": {
"operationId": "POST_DataExport_History_id_Cancel",
"summary": "Cancel the specified data export history record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Data export cancellation request created successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataExportHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Sends a cancellation request for the specified data export history record."
}
},
"/DataExport/History/{id}/Download": {
"get": {
"operationId": "GET_DataExport_History_id_Download",
"summary": "Retrieve the generated export file for a data export history record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataExportHistoryDownload"
}
}
},
"description": "Generated export file download payload."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataExportHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns export history metadata and a direct download link for the generated export file."
}
},
"/DataImport/{id}/LastUpload": {
"get": {
"operationId": "GET_DataImport_id_LastUpload",
"summary": "Retrieve the most recent DataImportUpload instance.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LastUpload"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImport object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/{id}": {
"post": {
"operationId": "POST_DataImport_Usage_id",
"summary": "Insert raw data usage record with payload that matches the requirements of Usage Feed specified by {id}",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportUsageIdParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Usage Feed to which this payload should be applied.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/{apifeedname}": {
"post": {
"operationId": "POST_DataImport_Usage_apifeedname",
"summary": "Create a DataImportUsage record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a DataImportUsage"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportUsage"
}
]
}
}
}
},
"parameters": [
{
"name": "apifeedname",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Json/{id}": {
"post": {
"operationId": "POST_DataImport_Usage_Json_id",
"summary": "Insert single raw data usage record in a JSON format for a Usage Feed specified by {id}",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportUsageJsonIdParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Usage Feed to which this payload should be applied.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Json/Multi/{id}": {
"post": {
"operationId": "POST_DataImport_Usage_Json_Multi_id",
"summary": "Insert multiple raw data usage records in a JSON format for a Usage Feed specified by {id}.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportUsageJsonMultiIdParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Usage Feed to which this payload should be applied.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Feed/{id}": {
"get": {
"operationId": "GET_DataImport_Usage_Feed_id",
"summary": "Retrieve a DataImportUsage record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportUsage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Feed/{name}": {
"get": {
"operationId": "GET_DataImport_Usage_Feed_name",
"summary": "List DataImportUsage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "name",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Tracking/{trackingId}": {
"get": {
"operationId": "GET_DataImport_Usage_Tracking_trackingId",
"summary": "List DataImportUsage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "trackingId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/Tracking/{trackingId}/Detail": {
"get": {
"operationId": "GET_DataImport_Usage_Tracking_trackingId_Detail",
"summary": "List DataImportUsage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "trackingId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/History/{id}": {
"get": {
"operationId": "GET_DataImport_Usage_History_id",
"summary": "Retrieve a DataImportUsage record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportUsage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/History": {
"get": {
"operationId": "GET_DataImport_Usage_History",
"summary": "List DataImportUsage records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataImport/Usage/History/{id}/Detail": {
"get": {
"operationId": "GET_DataImport_Usage_History_id_Detail",
"summary": "Retrieve a DataImportUsage record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataImportUsage"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportUsage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImport/Usage/History/{id}/Reprocess": {
"post": {
"operationId": "POST_DataImport_Usage_History_id_Reprocess",
"summary": "Reprocess the specified data import usage history record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Data import usage history reprocess request created successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportUsage object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Queues the specified data import usage history record for reprocessing."
}
},
"/DataImport/Usage/Download": {
"get": {
"operationId": "GET_DataImport_Usage_Download",
"summary": "Retrieve a download link for an imported usage file.",
"responses": {
"200": {
"description": "Imported usage file download payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataImportUsageDownloadResult"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns a direct download link for the imported usage file identified by the FileKey query parameter.",
"parameters": [
{
"name": "FileKey",
"in": "query",
"required": true,
"description": "Storage key that identifies the imported usage file to download.",
"schema": {
"type": "string",
"example": "imports/usage/2026/03/source-file.csv"
}
}
]
}
},
"/DataImport/CacheCategory": {
"get": {
"operationId": "GET_DataImport_CacheCategory",
"summary": "List DataImportCacheCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataImportCacheCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_DataImport_CacheCategory",
"summary": "Create a DataImportCacheCategory record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a DataImportCacheCategory"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportCacheCategory"
}
]
}
}
}
}
}
},
"/DataImport/CacheCategory/Paged": {
"get": {
"operationId": "GET_DataImport_CacheCategory_Paged",
"summary": "List DataImportCacheCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DataImportCacheCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataImport/CacheCategory/{id}": {
"get": {
"operationId": "GET_DataImport_CacheCategory_id",
"summary": "Retrieve a DataImportCacheCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataImportCacheCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportCacheCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_DataImport_CacheCategory_id",
"summary": "Update a DataImportCacheCategory record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a DataImportCacheCategory"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DataImportCacheCategory"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DayOfWeekType": {
"get": {
"operationId": "GET_DayOfWeekType",
"summary": "List DayOfWeekType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayOfWeekType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DayOfWeekType/Paged": {
"get": {
"operationId": "GET_DayOfWeekType_Paged",
"summary": "List DayOfWeekType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DayOfWeekType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DayOfWeekType/{id}": {
"get": {
"operationId": "GET_DayOfWeekType_id",
"summary": "Retrieve a DayOfWeekType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DayOfWeekType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DayOfWeekType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Discount/PromoCode": {
"get": {
"operationId": "GET_Discount_PromoCode",
"summary": "List DiscountPromoCode records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiscountPromoCode"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Discount_PromoCode",
"summary": "Create a DiscountPromoCode record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a DiscountPromoCode"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DiscountPromoCode"
}
]
}
}
}
}
}
},
"/Discount/PromoCode/Paged": {
"get": {
"operationId": "GET_Discount_PromoCode_Paged",
"summary": "List DiscountPromoCode records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DiscountPromoCode"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Discount/PromoCode/Paged/Detail": {
"get": {
"operationId": "GET_Discount_PromoCode_Paged_Detail",
"summary": "List DiscountPromoCode records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DiscountPromoCode"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Discount/PromoCode/{id}": {
"get": {
"operationId": "GET_Discount_PromoCode_id",
"summary": "Retrieve a DiscountPromoCode record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DiscountPromoCode"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DiscountPromoCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Discount_PromoCode_id",
"summary": "Update a DiscountPromoCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a DiscountPromoCode"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DiscountPromoCode"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Discount_PromoCode_id",
"summary": "Patch a DiscountPromoCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DiscountPromoCode"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DiscountPromoCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Discount_PromoCode_id",
"summary": "Delete a DiscountPromoCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DiscountPromoCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Discount/PromoCode/{id}/Detail": {
"get": {
"operationId": "GET_Discount_PromoCode_id_Detail",
"summary": "Retrieve a DiscountPromoCode record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DiscountPromoCode"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DiscountPromoCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DiscountType": {
"get": {
"operationId": "GET_DiscountType",
"summary": "List DiscountType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DiscountType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DiscountType/Paged": {
"get": {
"operationId": "GET_DiscountType_Paged",
"summary": "List DiscountType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/DiscountType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DiscountType/{id}": {
"get": {
"operationId": "GET_DiscountType_id",
"summary": "Retrieve a DiscountType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DiscountType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DiscountType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailSetting/SMTPAuth/{id}": {
"get": {
"operationId": "GET_EmailSetting_SMTPAuth_id",
"summary": "Retrieve a EmailSetting record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/EmailSetting"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailSetting object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_EmailSetting_SMTPAuth_id",
"summary": "Update a EmailSetting record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EmailSetting"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailSetting"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailSetting/SMTPAuth": {
"post": {
"operationId": "POST_EmailSetting_SMTPAuth",
"summary": "Create a EmailSetting record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a EmailSetting"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailSetting"
}
]
}
}
}
}
}
},
"/EmailSetting/{id}": {
"delete": {
"operationId": "DELETE_EmailSetting_id",
"summary": "Delete a EmailSetting record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailSetting object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailSetting/GoogleJWT/{id}": {
"get": {
"operationId": "GET_EmailSetting_GoogleJWT_id",
"summary": "Retrieve a EmailSetting record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/EmailSetting"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailSetting object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_EmailSetting_GoogleJWT_id",
"summary": "Update a EmailSetting record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EmailSetting"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailSetting"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailSetting/GoogleJWT": {
"post": {
"operationId": "POST_EmailSetting_GoogleJWT",
"summary": "Create a EmailSetting record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a EmailSetting"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailSetting"
}
]
}
}
}
}
}
},
"/EmailTemplate": {
"get": {
"operationId": "GET_EmailTemplate",
"summary": "List EmailTemplate records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EmailTemplate/Paged": {
"get": {
"operationId": "GET_EmailTemplate_Paged",
"summary": "List EmailTemplate records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EmailTemplate/{id}": {
"get": {
"operationId": "GET_EmailTemplate_id",
"summary": "Retrieve a EmailTemplate record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_EmailTemplate_id",
"summary": "Delete a EmailTemplate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailTemplate/{id}/Detail": {
"get": {
"operationId": "GET_EmailTemplate_id_Detail",
"summary": "Retrieve a EmailTemplate record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/EmailTemplate"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailTemplate/Upload": {
"post": {
"operationId": "POST_EmailTemplate_Upload",
"summary": "Create a EmailTemplate record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a EmailTemplate"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailTemplate"
}
]
}
}
}
}
}
},
"/EmailTemplate/Upload/{id}": {
"patch": {
"operationId": "PATCH_EmailTemplate_Upload_id",
"summary": "Patch a EmailTemplate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailTemplate"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_EmailTemplate_Upload_id",
"summary": "Update a EmailTemplate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EmailTemplate"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EmailTemplate"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailTemplate/Type": {
"get": {
"operationId": "GET_EmailTemplate_Type",
"summary": "List EmailTemplateType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EmailTemplate/Type/Paged": {
"get": {
"operationId": "GET_EmailTemplate_Type_Paged",
"summary": "List EmailTemplateType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/EmailTemplateType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EmailTemplate/Type/{id}": {
"get": {
"operationId": "GET_EmailTemplate_Type_id",
"summary": "Retrieve a EmailTemplateType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/EmailTemplateType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplateType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EmailTemplate/Type/{id}/AvailableTokens": {
"get": {
"operationId": "GET_EmailTemplate_Type_id_AvailableTokens",
"summary": "List AvailableTokens records for the specified EmailTemplateType.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableTokens"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EmailTemplateType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EventRegistration/External": {
"get": {
"operationId": "GET_EventRegistration_External",
"summary": "List EventRegistration records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventRegistration"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EventSubscription/Email": {
"post": {
"operationId": "POST_EventSubscription_Email",
"summary": "Create a EventSubscription record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a EventSubscription"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
}
},
"get": {
"operationId": "GET_EventSubscription_Email",
"summary": "List EventSubscription records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSubscription"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EventSubscription/Email/{id}": {
"put": {
"operationId": "PUT_EventSubscription_Email_id",
"summary": "Update a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EventSubscription"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_EventSubscription_Email_id",
"summary": "Patch a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EventSubscription object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_EventSubscription_Email_id",
"summary": "Delete a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EventSubscription object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/EventSubscription/Webhook": {
"post": {
"operationId": "POST_EventSubscription_Webhook",
"summary": "Create a EventSubscription record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a EventSubscription"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
}
},
"get": {
"operationId": "GET_EventSubscription_Webhook",
"summary": "List EventSubscription records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSubscription"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/EventSubscription/Webhook/{id}": {
"put": {
"operationId": "PUT_EventSubscription_Webhook_id",
"summary": "Update a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a EventSubscription"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_EventSubscription_Webhook_id",
"summary": "Patch a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EventSubscription"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EventSubscription object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_EventSubscription_Webhook_id",
"summary": "Delete a EventSubscription record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the EventSubscription object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute": {
"get": {
"operationId": "GET_Extension_Attribute",
"summary": "List ExtensionAttribute records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Paged": {
"get": {
"operationId": "GET_Extension_Attribute_Paged",
"summary": "List ExtensionAttribute records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Paged/Detail": {
"get": {
"operationId": "GET_Extension_Attribute_Paged_Detail",
"summary": "List ExtensionAttribute records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/{id}": {
"get": {
"operationId": "GET_Extension_Attribute_id",
"summary": "Retrieve a ExtensionAttribute record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttribute object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute/{id}/Detail": {
"get": {
"operationId": "GET_Extension_Attribute_id_Detail",
"summary": "Retrieve a ExtensionAttribute record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttribute"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttribute object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute/Entity": {
"get": {
"operationId": "GET_Extension_Attribute_Entity",
"summary": "List ExtensionAttributeEntity records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeEntity"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Entity/Paged": {
"get": {
"operationId": "GET_Extension_Attribute_Entity_Paged",
"summary": "List ExtensionAttributeEntity records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeEntity"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Entity/{id}": {
"get": {
"operationId": "GET_Extension_Attribute_Entity_id",
"summary": "Retrieve a ExtensionAttributeEntity record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttributeEntity"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttributeEntity object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute/ListItem": {
"get": {
"operationId": "GET_Extension_Attribute_ListItem",
"summary": "List ExtensionAttributeListItem records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeListItem"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/ListItem/Paged": {
"get": {
"operationId": "GET_Extension_Attribute_ListItem_Paged",
"summary": "List ExtensionAttributeListItem records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeListItem"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/ListItem/{id}": {
"get": {
"operationId": "GET_Extension_Attribute_ListItem_id",
"summary": "Retrieve a ExtensionAttributeListItem record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttributeListItem"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttributeListItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute/ListType": {
"get": {
"operationId": "GET_Extension_Attribute_ListType",
"summary": "List ExtensionAttributeListType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeListType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/ListType/Paged": {
"get": {
"operationId": "GET_Extension_Attribute_ListType_Paged",
"summary": "List ExtensionAttributeListType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeListType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/ListType/{id}": {
"get": {
"operationId": "GET_Extension_Attribute_ListType_id",
"summary": "Retrieve a ExtensionAttributeListType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttributeListType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttributeListType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Extension/Attribute/Lookup": {
"get": {
"operationId": "GET_Extension_Attribute_Lookup",
"summary": "List ExtensionAttributeLookup records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeLookup"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Lookup/Paged": {
"get": {
"operationId": "GET_Extension_Attribute_Lookup_Paged",
"summary": "List ExtensionAttributeLookup records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ExtensionAttributeLookup"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Extension/Attribute/Lookup/{id}": {
"get": {
"operationId": "GET_Extension_Attribute_Lookup_id",
"summary": "Retrieve a ExtensionAttributeLookup record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ExtensionAttributeLookup"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ExtensionAttributeLookup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/FrequencyType": {
"get": {
"operationId": "GET_FrequencyType",
"summary": "List FrequencyType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FrequencyType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/FrequencyType/Paged": {
"get": {
"operationId": "GET_FrequencyType_Paged",
"summary": "List FrequencyType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/FrequencyType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/FrequencyType/{id}": {
"get": {
"operationId": "GET_FrequencyType_id",
"summary": "Retrieve a FrequencyType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/FrequencyType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the FrequencyType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GatewayType": {
"get": {
"operationId": "GET_GatewayType",
"summary": "List GatewayType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GatewayType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GatewayType/Paged": {
"get": {
"operationId": "GET_GatewayType_Paged",
"summary": "List GatewayType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GatewayType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GatewayType/{id}": {
"get": {
"operationId": "GET_GatewayType_id",
"summary": "Retrieve a GatewayType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GatewayType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GatewayType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GatewayType/Details/{id}": {
"get": {
"operationId": "GET_GatewayType_Details_id",
"summary": "Retrieve a GatewayType record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GatewayType"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GatewayType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeneralLedger": {
"get": {
"operationId": "GET_GeneralLedger",
"summary": "List GeneralLedger records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeneralLedger"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_GeneralLedger",
"summary": "Create a GeneralLedger record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a GeneralLedger"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralLedger"
}
]
}
}
}
}
}
},
"/GeneralLedger/Paged": {
"get": {
"operationId": "GET_GeneralLedger_Paged",
"summary": "List GeneralLedger records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeneralLedger"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeneralLedger/{id}": {
"get": {
"operationId": "GET_GeneralLedger_id",
"summary": "Retrieve a GeneralLedger record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeneralLedger"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeneralLedger object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_GeneralLedger_id",
"summary": "Update a GeneralLedger record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a GeneralLedger"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeneralLedger"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_GeneralLedger_id",
"summary": "Delete a GeneralLedger record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeneralLedger object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeoTree/Location": {
"get": {
"operationId": "GET_GeoTree_Location",
"summary": "List GeoTreeLocation records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoTreeLocation"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_GeoTree_Location",
"summary": "Create a GeoTreeLocation record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a GeoTreeLocation"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocation"
}
]
}
}
}
}
}
},
"/GeoTree/Location/Paged": {
"get": {
"operationId": "GET_GeoTree_Location_Paged",
"summary": "List GeoTreeLocation records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeoTreeLocation"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeoTree/Location/Paged/Detail": {
"get": {
"operationId": "GET_GeoTree_Location_Paged_Detail",
"summary": "List GeoTreeLocation records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeoTreeLocation"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeoTree/Location/{id}": {
"get": {
"operationId": "GET_GeoTree_Location_id",
"summary": "Retrieve a GeoTreeLocation record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeoTreeLocation"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocation object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_GeoTree_Location_id",
"summary": "Update a GeoTreeLocation record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a GeoTreeLocation"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocation"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_GeoTree_Location_id",
"summary": "Patch a GeoTreeLocation record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocation"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocation object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_GeoTree_Location_id",
"summary": "Delete a GeoTreeLocation record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocation object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeoTree/Location/{id}/Detail": {
"get": {
"operationId": "GET_GeoTree_Location_id_Detail",
"summary": "Retrieve a GeoTreeLocation record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeoTreeLocation"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocation object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeoTree/Location/Group": {
"get": {
"operationId": "GET_GeoTree_Location_Group",
"summary": "List GeoTreeLocationGroup records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_GeoTree_Location_Group",
"summary": "Create a GeoTreeLocationGroup record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a GeoTreeLocationGroup"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
]
}
}
}
}
}
},
"/GeoTree/Location/Group/Paged": {
"get": {
"operationId": "GET_GeoTree_Location_Group_Paged",
"summary": "List GeoTreeLocationGroup records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeoTree/Location/Group/Paged/Detail": {
"get": {
"operationId": "GET_GeoTree_Location_Group_Paged_Detail",
"summary": "List GeoTreeLocationGroup records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeoTree/Location/Group/{id}": {
"get": {
"operationId": "GET_GeoTree_Location_Group_id",
"summary": "Retrieve a GeoTreeLocationGroup record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_GeoTree_Location_Group_id",
"summary": "Update a GeoTreeLocationGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a GeoTreeLocationGroup"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_GeoTree_Location_Group_id",
"summary": "Patch a GeoTreeLocationGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_GeoTree_Location_Group_id",
"summary": "Delete a GeoTreeLocationGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeoTree/Location/Group/{id}/Detail": {
"get": {
"operationId": "GET_GeoTree_Location_Group_id_Detail",
"summary": "Retrieve a GeoTreeLocationGroup record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeoTreeLocationGroup"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/GeoTree/Location/Pattern": {
"get": {
"operationId": "GET_GeoTree_Location_Pattern",
"summary": "List GeoTreeLocationPattern records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoTreeLocationPattern"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_GeoTree_Location_Pattern",
"summary": "Create a GeoTreeLocationPattern record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a GeoTreeLocationPattern"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocationPattern"
}
]
}
}
}
}
}
},
"/GeoTree/Location/Pattern/Paged": {
"get": {
"operationId": "GET_GeoTree_Location_Pattern_Paged",
"summary": "List GeoTreeLocationPattern records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/GeoTreeLocationPattern"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/GeoTree/Location/Pattern/{id}": {
"get": {
"operationId": "GET_GeoTree_Location_Pattern_id",
"summary": "Retrieve a GeoTreeLocationPattern record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/GeoTreeLocationPattern"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationPattern object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_GeoTree_Location_Pattern_id",
"summary": "Update a GeoTreeLocationPattern record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a GeoTreeLocationPattern"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GeoTreeLocationPattern"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_GeoTree_Location_Pattern_id",
"summary": "Delete a GeoTreeLocationPattern record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the GeoTreeLocationPattern object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice": {
"get": {
"operationId": "GET_Invoice",
"summary": "List Invoice records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Paged": {
"get": {
"operationId": "GET_Invoice_Paged",
"summary": "List Invoice records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Paged/Detail": {
"get": {
"operationId": "GET_Invoice_Paged_Detail",
"summary": "List Invoice records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/{id}": {
"get": {
"operationId": "GET_Invoice_id",
"summary": "Retrieve a Invoice record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Invoice"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Invoice_id",
"summary": "Update a Invoice record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Invoice"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Invoice"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/{id}/Detail": {
"get": {
"operationId": "GET_Invoice_id_Detail",
"summary": "Retrieve a Invoice record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Invoice"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/{id}/Void": {
"post": {
"operationId": "POST_Invoice_id_Void",
"summary": "Void the specified Invoice.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Action completed successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Void"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/{id}/Download": {
"get": {
"operationId": "GET_Invoice_id_Download",
"summary": "Retrieve the rendered PDF for an invoice.",
"responses": {
"200": {
"description": "Rendered invoice download payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceIdDownloadResult"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "linkOnly",
"in": "query",
"required": false,
"description": "When true, returns the download link metadata without embedding the base64 PDF content.",
"schema": {
"type": "boolean",
"example": false
}
}
],
"description": "Returns the rendered invoice PDF content and download link for the specified invoice. Use the optional linkOnly query parameter to return only the download link metadata."
}
},
"/Invoice/{id}/ReRender": {
"post": {
"operationId": "POST_Invoice_id_ReRender",
"summary": "Queue re-rendering for an invoice.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"description": "Invoice re-render request accepted successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceIdReRenderParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Creates re-render work for the specified invoice."
}
},
"/Invoice/{id}/Delivery": {
"post": {
"operationId": "POST_Invoice_id_Delivery",
"summary": "Deliver the specified invoice to its configured recipients.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Invoice delivery request created successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Invoice object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Triggers delivery of the specified invoice using its configured delivery settings."
}
},
"/Invoice/ByName": {
"get": {
"operationId": "GET_Invoice_ByName",
"summary": "Search invoices by name or number.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
}
}
]
}
}
},
"description": "List of matching invoices."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"in": "query",
"required": false,
"name": "invoiceName",
"description": "Invoice name or number to search for.",
"schema": {
"type": "string",
"example": "18337"
}
},
{
"in": "query",
"required": false,
"name": "operator",
"description": "Search operator used when matching the supplied value.",
"schema": {
"type": "string",
"example": "contains"
}
}
],
"description": "Returns invoices that match the supplied invoice name criteria."
}
},
"/Invoice/DateProcessType": {
"get": {
"operationId": "GET_Invoice_DateProcessType",
"summary": "List InvoiceDateProcessType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDateProcessType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DateProcessType/Paged": {
"get": {
"operationId": "GET_Invoice_DateProcessType_Paged",
"summary": "List InvoiceDateProcessType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDateProcessType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DateProcessType/{id}": {
"get": {
"operationId": "GET_Invoice_DateProcessType_id",
"summary": "Retrieve a InvoiceDateProcessType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDateProcessType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDateProcessType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Delivery": {
"get": {
"operationId": "GET_Invoice_Delivery",
"summary": "List InvoiceDelivery records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDelivery"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Invoice_Delivery",
"summary": "Create a InvoiceDelivery record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceDelivery"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceDelivery"
}
]
}
}
}
}
}
},
"/Invoice/Delivery/Paged": {
"get": {
"operationId": "GET_Invoice_Delivery_Paged",
"summary": "List InvoiceDelivery records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDelivery"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Delivery/Paged/Detail": {
"get": {
"operationId": "GET_Invoice_Delivery_Paged_Detail",
"summary": "List InvoiceDelivery records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDelivery"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Delivery/{id}": {
"get": {
"operationId": "GET_Invoice_Delivery_id",
"summary": "Retrieve a InvoiceDelivery record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDelivery"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDelivery object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Invoice_Delivery_id",
"summary": "Update a InvoiceDelivery record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a InvoiceDelivery"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceDelivery"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Invoice_Delivery_id",
"summary": "Patch a InvoiceDelivery record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceDelivery"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDelivery object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Invoice_Delivery_id",
"summary": "Delete a InvoiceDelivery record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDelivery object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Delivery/{id}/Detail": {
"get": {
"operationId": "GET_Invoice_Delivery_id_Detail",
"summary": "Retrieve a InvoiceDelivery record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDelivery"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDelivery object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/DueDateType": {
"get": {
"operationId": "GET_Invoice_DueDateType",
"summary": "List InvoiceDueDateType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDueDateType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DueDateType/Paged": {
"get": {
"operationId": "GET_Invoice_DueDateType_Paged",
"summary": "List InvoiceDueDateType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDueDateType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DueDateType/{id}": {
"get": {
"operationId": "GET_Invoice_DueDateType_id",
"summary": "Retrieve a InvoiceDueDateType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDueDateType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDueDateType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/ExportOptionType": {
"get": {
"operationId": "GET_Invoice_ExportOptionType",
"summary": "List InvoiceExportOptionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceExportOptionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/ExportOptionType/Paged": {
"get": {
"operationId": "GET_Invoice_ExportOptionType_Paged",
"summary": "List InvoiceExportOptionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceExportOptionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/ExportOptionType/{id}": {
"get": {
"operationId": "GET_Invoice_ExportOptionType_id",
"summary": "Retrieve a InvoiceExportOptionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceExportOptionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceExportOptionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/History": {
"get": {
"operationId": "GET_Invoice_History",
"summary": "List InvoiceHistory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceHistory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/History/Paged": {
"get": {
"operationId": "GET_Invoice_History_Paged",
"summary": "List InvoiceHistory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceHistory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/History/{id}": {
"get": {
"operationId": "GET_Invoice_History_id",
"summary": "Retrieve a InvoiceHistory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceHistory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Item": {
"get": {
"operationId": "GET_Invoice_Item",
"summary": "List InvoiceItem records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Item/Paged": {
"get": {
"operationId": "GET_Invoice_Item_Paged",
"summary": "List InvoiceItem records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Item/Paged/Detail": {
"get": {
"operationId": "GET_Invoice_Item_Paged_Detail",
"summary": "List InvoiceItem records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Item/{id}": {
"get": {
"operationId": "GET_Invoice_Item_id",
"summary": "Retrieve a InvoiceItem record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Invoice_Item_id",
"summary": "Update a InvoiceItem record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a InvoiceItem"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Invoice_Item_id",
"summary": "Patch a InvoiceItem record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Invoice_Item_id",
"summary": "Delete a InvoiceItem record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Item/{id}/Detail": {
"get": {
"operationId": "GET_Invoice_Item_id_Detail",
"summary": "Retrieve a InvoiceItem record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Item/ReverseCharge": {
"post": {
"operationId": "POST_Invoice_Item_ReverseCharge",
"summary": "Create a InvoiceItem record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceItem"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
}
}
},
"/Invoice/Item/ReverseCredit": {
"post": {
"operationId": "POST_Invoice_Item_ReverseCredit",
"summary": "Create a InvoiceItem record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceItem"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
}
}
},
"/Invoice/Item/Credit": {
"post": {
"operationId": "POST_Invoice_Item_Credit",
"summary": "Create an InvoiceItem that is a Credit.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceItem"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItemCreditParam"
}
]
}
}
}
},
"description": " The Credit Resource has only the necessary properties to create a credit. This is typically easier to use than an InvoiceItem."
}
},
"/Invoice/Item/TaxAdjustment": {
"post": {
"operationId": "POST_Invoice_Item_TaxAdjustment",
"summary": "Create a InvoiceItem record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceItem"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
}
}
},
"/Invoice/Item/TaxAdjustment/{id}": {
"patch": {
"operationId": "PATCH_Invoice_Item_TaxAdjustment_id",
"summary": "Patch a InvoiceItem record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItem"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/Item/Charge": {
"post": {
"operationId": "POST_Invoice_Item_Charge",
"summary": "Use this API to create Manual Charge , Invoice Item Type = 8 ( One Time Charge )",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a InvoiceItem"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InvoiceItemChargeParam"
}
]
}
}
}
},
"description": " The Charge Resource has only the necessary properties to create a one-time manual charge."
}
},
"/Invoice/Item/TaxSummary": {
"get": {
"operationId": "GET_Invoice_Item_TaxSummary",
"summary": "List InvoiceItem records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/Item/{id}/TaxSummary": {
"get": {
"operationId": "GET_Invoice_Item_id_TaxSummary",
"summary": "List TaxSummary records for the specified InvoiceItem.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxSummary"
}
}
}
}
]
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItem object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/InvoiceItemType": {
"get": {
"operationId": "GET_InvoiceItemType",
"summary": "List InvoiceItemType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItemType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/InvoiceItemType/Paged": {
"get": {
"operationId": "GET_InvoiceItemType_Paged",
"summary": "List InvoiceItemType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceItemType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/InvoiceItemType/{id}": {
"get": {
"operationId": "GET_InvoiceItemType_id",
"summary": "Retrieve a InvoiceItemType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceItemType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceItemType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/StatusType": {
"get": {
"operationId": "GET_Invoice_StatusType",
"summary": "List InvoiceStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/StatusType/Paged": {
"get": {
"operationId": "GET_Invoice_StatusType_Paged",
"summary": "List InvoiceStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/StatusType/{id}": {
"get": {
"operationId": "GET_Invoice_StatusType_id",
"summary": "Retrieve a InvoiceStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/ByUdrMediated/{id}": {
"get": {
"operationId": "GET_Invoice_ByUdrMediated_id",
"summary": "Retrieve the invoice information for a specific mediated usage record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceByUdrMediatedIdResult"
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceByUdrMediated object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/DeliveryType": {
"get": {
"operationId": "GET_Invoice_DeliveryType",
"summary": "List InvoiceDeliveryType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDeliveryType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DeliveryType/Paged": {
"get": {
"operationId": "GET_Invoice_DeliveryType_Paged",
"summary": "List InvoiceDeliveryType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDeliveryType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DeliveryType/{id}": {
"get": {
"operationId": "GET_Invoice_DeliveryType_id",
"summary": "Retrieve a InvoiceDeliveryType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDeliveryType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDeliveryType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/DiscountCalculationType": {
"get": {
"operationId": "GET_Invoice_DiscountCalculationType",
"summary": "List InvoiceDiscountCalculationType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDiscountCalculationType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DiscountCalculationType/Paged": {
"get": {
"operationId": "GET_Invoice_DiscountCalculationType_Paged",
"summary": "List InvoiceDiscountCalculationType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDiscountCalculationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DiscountCalculationType/{id}": {
"get": {
"operationId": "GET_Invoice_DiscountCalculationType_id",
"summary": "Retrieve a InvoiceDiscountCalculationType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDiscountCalculationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDiscountCalculationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Invoice/DiscountType": {
"get": {
"operationId": "GET_Invoice_DiscountType",
"summary": "List InvoiceDiscountType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDiscountType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DiscountType/Paged": {
"get": {
"operationId": "GET_Invoice_DiscountType_Paged",
"summary": "List InvoiceDiscountType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/InvoiceDiscountType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Invoice/DiscountType/{id}": {
"get": {
"operationId": "GET_Invoice_DiscountType_id",
"summary": "Retrieve a InvoiceDiscountType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDiscountType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the InvoiceDiscountType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/JsonApi/Log/ByRequestTracking/{id}": {
"get": {
"operationId": "GET_JsonApi_Log_ByRequestTracking_id",
"summary": "Retrieve a JsonApiLog record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/JsonApiLog"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the JsonApiLog object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Locale": {
"get": {
"operationId": "GET_Locale",
"summary": "List Locale records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Locale"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Locale",
"summary": "Create a Locale record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Locale"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Locale"
}
]
}
}
}
}
}
},
"/Locale/Paged": {
"get": {
"operationId": "GET_Locale_Paged",
"summary": "List Locale records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Locale"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Locale/{id}": {
"get": {
"operationId": "GET_Locale_id",
"summary": "Retrieve a Locale record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Locale"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Locale object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Locale_id",
"summary": "Update a Locale record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Locale"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Locale"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Locale_id",
"summary": "Delete a Locale record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Locale object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Note": {
"get": {
"operationId": "GET_Note",
"summary": "List Note records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Note"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Note",
"summary": "Create a Note record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Note"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Note"
}
]
}
}
}
}
}
},
"/Note/Paged": {
"get": {
"operationId": "GET_Note_Paged",
"summary": "List Note records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Note"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Note/{id}": {
"get": {
"operationId": "GET_Note_id",
"summary": "Retrieve a Note record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Note"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Note object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Note_id",
"summary": "Update a Note record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Note"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Note"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Note_id",
"summary": "Delete a Note record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Note object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/NoteType": {
"get": {
"operationId": "GET_NoteType",
"summary": "List NoteType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/NoteType/Paged": {
"get": {
"operationId": "GET_NoteType_Paged",
"summary": "List NoteType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/NoteType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/NoteType/{id}": {
"get": {
"operationId": "GET_NoteType_id",
"summary": "Retrieve a NoteType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/NoteType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the NoteType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Order": {
"get": {
"operationId": "GET_Order",
"summary": "List Order records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Order",
"summary": "Create a Order record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Order"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/OrderProcessParam"
}
]
}
}
}
}
}
},
"/Order/Paged": {
"get": {
"operationId": "GET_Order_Paged",
"summary": "List Order records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Order/Paged/Detail": {
"get": {
"operationId": "GET_Order_Paged_Detail",
"summary": "List Order records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Order/{id}": {
"get": {
"operationId": "GET_Order_id",
"summary": "Retrieve a Order record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Order"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Order object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Order_id",
"summary": "Update a Order record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Order"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Order"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Order_id",
"summary": "Patch a Order record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Order"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Order object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Order_id",
"summary": "Delete a Order record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Order object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Order/{id}/Detail": {
"get": {
"operationId": "GET_Order_id_Detail",
"summary": "Retrieve a Order record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Order"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Order object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Order/Process": {
"post": {
"operationId": "POST_Order_Process",
"summary": "Process an existing draft Order or re-process an existing failed Order.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Order"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Order"
}
]
}
}
}
},
"description": " Optionally, the order can be billed immediately via billNow: true. Billing now is required if there are manual charges that need to be included, otherwise they are not billed."
}
},
"/Order/{orderId}/Status": {
"get": {
"operationId": "GET_Order_orderId_Status",
"summary": "List Order records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "orderId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Order/{orderId}/PackageTracking/Paged": {
"get": {
"operationId": "GET_Order_orderId_PackageTracking_Paged",
"summary": "List Order records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "orderId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Order/{orderId}/PackageTracking": {
"get": {
"operationId": "GET_Order_orderId_PackageTracking",
"summary": "List Order records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "orderId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/OrderStatusType": {
"get": {
"operationId": "GET_OrderStatusType",
"summary": "List OrderStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/OrderStatusType/Paged": {
"get": {
"operationId": "GET_OrderStatusType_Paged",
"summary": "List OrderStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/OrderStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/OrderStatusType/{id}": {
"get": {
"operationId": "GET_OrderStatusType_id",
"summary": "Retrieve a OrderStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/OrderStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the OrderStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Owner": {
"get": {
"operationId": "GET_Owner",
"summary": "List Owner records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Owner"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Owner/Paged": {
"get": {
"operationId": "GET_Owner_Paged",
"summary": "List Owner records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Owner"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Owner/Paged/Detail": {
"get": {
"operationId": "GET_Owner_Paged_Detail",
"summary": "List Owner records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Owner"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Owner/{id}": {
"get": {
"operationId": "GET_Owner_id",
"summary": "Retrieve a Owner record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Owner"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Owner object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Owner_id",
"summary": "Patch a Owner record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Owner object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Owner/{id}/Detail": {
"get": {
"operationId": "GET_Owner_id_Detail",
"summary": "Retrieve a Owner record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Owner"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Owner object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package": {
"get": {
"operationId": "GET_Package",
"summary": "List Package records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Package",
"summary": "Create a Package record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Package"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Package"
}
]
}
}
}
}
}
},
"/Package/Paged": {
"get": {
"operationId": "GET_Package_Paged",
"summary": "List Package records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Paged/Detail": {
"get": {
"operationId": "GET_Package_Paged_Detail",
"summary": "List Package records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/{id}": {
"get": {
"operationId": "GET_Package_id",
"summary": "Retrieve a Package record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Package"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Package object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Package_id",
"summary": "Update a Package record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Package"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Package"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Package_id",
"summary": "Patch a Package record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Package"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Package object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Package_id",
"summary": "Delete a Package record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Package object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/{id}/Detail": {
"get": {
"operationId": "GET_Package_id_Detail",
"summary": "Retrieve a Package record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Package"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Package object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/AvailableFor/Currency/{id}": {
"get": {
"operationId": "GET_Package_AvailableFor_Currency_id",
"summary": "Retrieve Package objects that are avaialable for the specified Currency.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageAvailableForCurrencyIdResults"
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Currency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Category": {
"get": {
"operationId": "GET_Package_Category",
"summary": "List PackageCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Category/Paged": {
"get": {
"operationId": "GET_Package_Category_Paged",
"summary": "List PackageCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Category/{id}": {
"get": {
"operationId": "GET_Package_Category_id",
"summary": "Retrieve a PackageCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Currency": {
"get": {
"operationId": "GET_Package_Currency",
"summary": "List PackageCurrency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageCurrency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Currency/Paged": {
"get": {
"operationId": "GET_Package_Currency_Paged",
"summary": "List PackageCurrency records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageCurrency"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Currency/{id}": {
"get": {
"operationId": "GET_Package_Currency_id",
"summary": "Retrieve a PackageCurrency record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageCurrency"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageCurrency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency": {
"get": {
"operationId": "GET_Package_Frequency",
"summary": "List PackageFrequency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Package_Frequency",
"summary": "Create a PackageFrequency record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PackageFrequency"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageFrequency"
}
]
}
}
}
}
}
},
"/Package/Frequency/Paged": {
"get": {
"operationId": "GET_Package_Frequency_Paged",
"summary": "List PackageFrequency records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Frequency/Paged/Detail": {
"get": {
"operationId": "GET_Package_Frequency_Paged_Detail",
"summary": "List PackageFrequency records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Frequency/{id}": {
"get": {
"operationId": "GET_Package_Frequency_id",
"summary": "Retrieve a PackageFrequency record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Package_Frequency_id",
"summary": "Update a PackageFrequency record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PackageFrequency"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageFrequency"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Package_Frequency_id",
"summary": "Patch a PackageFrequency record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageFrequency"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Package_Frequency_id",
"summary": "Delete a PackageFrequency record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency/{id}/Detail": {
"get": {
"operationId": "GET_Package_Frequency_id_Detail",
"summary": "Retrieve a PackageFrequency record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency/AvailableFor/Package/{id}/Currency/{currencyId}": {
"get": {
"parameters": [
{
"description": "Unique identifier of the package.",
"name": "id",
"required": true,
"schema": {
"example": 45,
"type": "integer"
},
"in": "path"
},
{
"description": "Unique identifier of the currency.",
"name": "currencyId",
"required": true,
"schema": {
"example": 1,
"type": "integer"
},
"in": "path"
}
],
"summary": "Retrieve package frequencies available for the specified package and currency.",
"description": "Returns the package frequency records that are valid for the specified package when pricing is evaluated in the specified currency.",
"operationId": "GET_Package_Frequency_AvailableFor_Package_id_Currency_currencyId",
"responses": {
"200": {
"description": "List of package frequencies available for the package and currency.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageFrequencyListResponse"
}
}
}
},
"400": {
"description": "Error occurred during this request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Frequency/{packageFrequencyId}/PriceBook/{priceBookId}/Currency/{currencyCode}/Pricing": {
"get": {
"operationId": "GET_Package_Frequency_packageFrequencyId_PriceBook_priceBookId_Currency_currencyCode_Pricing",
"summary": "List PackageFrequency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "packageFrequencyId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "priceBookId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "currencyCode",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/Package/Frequency/{packageFrequencyId}/PriceBook/{priceBookId}/Currency/{currencyId}/Pricing": {
"get": {
"operationId": "GET_Package_Frequency_packageFrequencyId_PriceBook_priceBookId_Currency_currencyId_Pricing",
"summary": "List PackageFrequency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "packageFrequencyId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "priceBookId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "currencyId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency/{id}/Basic/Detail": {
"get": {
"operationId": "GET_Package_Frequency_id_Basic_Detail",
"summary": "Retrieve a PackageFrequency record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency/{packageFrequencyid}/PriceBook/{priceBookId}/Currency/{currencyCode}/UsageBucketTier": {
"get": {
"operationId": "GET_Package_Frequency_packageFrequencyid_PriceBook_priceBookId_Currency_currencyCode_UsageBucketTier",
"summary": "List PackageFrequency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "packageFrequencyid",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "priceBookId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "currencyCode",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/Package/Frequency/{packageFrequencyid}/PriceBook/{priceBookId}/Currency/{currencyId}/UsageBucketTier": {
"get": {
"operationId": "GET_Package_Frequency_packageFrequencyid_PriceBook_priceBookId_Currency_currencyId_UsageBucketTier",
"summary": "List PackageFrequency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "packageFrequencyid",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "priceBookId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "currencyId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Frequency/Currency": {
"get": {
"operationId": "GET_Package_Frequency_Currency",
"summary": "List PackageFrequencyPackageCurrency records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageFrequencyPackageCurrency"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Frequency/Currency/Paged": {
"get": {
"operationId": "GET_Package_Frequency_Currency_Paged",
"summary": "List PackageFrequencyPackageCurrency records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageFrequencyPackageCurrency"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Frequency/Currency/{id}": {
"get": {
"operationId": "GET_Package_Frequency_Currency_id",
"summary": "Retrieve a PackageFrequencyPackageCurrency record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageFrequencyPackageCurrency"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageFrequencyPackageCurrency object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Service": {
"get": {
"operationId": "GET_Package_Service",
"summary": "List PackageService records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageService"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Service/Paged": {
"get": {
"operationId": "GET_Package_Service_Paged",
"summary": "List PackageService records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageService"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Service/Paged/Detail": {
"get": {
"operationId": "GET_Package_Service_Paged_Detail",
"summary": "List PackageService records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageService"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Service/{id}": {
"get": {
"operationId": "GET_Package_Service_id",
"summary": "Retrieve a PackageService record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageService"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Service/{id}/Detail": {
"get": {
"operationId": "GET_Package_Service_id_Detail",
"summary": "Retrieve a PackageService record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageService"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageService object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Service/PricePlan": {
"get": {
"operationId": "GET_Package_Service_PricePlan",
"summary": "List PackageServicePricePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageServicePricePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Package_Service_PricePlan",
"summary": "Create a PackageServicePricePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PackageServicePricePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageServicePricePlan"
}
]
}
}
}
}
}
},
"/Package/Service/PricePlan/Paged": {
"get": {
"operationId": "GET_Package_Service_PricePlan_Paged",
"summary": "List PackageServicePricePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageServicePricePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Service/PricePlan/Paged/Detail": {
"get": {
"operationId": "GET_Package_Service_PricePlan_Paged_Detail",
"summary": "List PackageServicePricePlan records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PackageServicePricePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Package/Service/PricePlan/{id}": {
"get": {
"operationId": "GET_Package_Service_PricePlan_id",
"summary": "Retrieve a PackageServicePricePlan record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageServicePricePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageServicePricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Package_Service_PricePlan_id",
"summary": "Update a PackageServicePricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PackageServicePricePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageServicePricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Package_Service_PricePlan_id",
"summary": "Patch a PackageServicePricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageServicePricePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageServicePricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Package_Service_PricePlan_id",
"summary": "Delete a PackageServicePricePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageServicePricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Service/PricePlan/{id}/Detail": {
"get": {
"operationId": "GET_Package_Service_PricePlan_id_Detail",
"summary": "Retrieve a PackageServicePricePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PackageServicePricePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PackageServicePricePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Package/Service/PricePlan/AvailableFor/Account/{id}/AccountProductCode/{accountProductCodeId}": {
"get": {
"operationId": "GET_Package_Service_PricePlan_AvailableFor_Account_id_AccountProductCode_accountProductCodeId",
"summary": "Retrieve the package service price plan available for an account product code.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackageServicePricePlanAvailableForResult"
}
}
},
"description": "Get a AccountProductCode by its ID based on a specified PackageServicePricePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Account object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
},
{
"name": "accountProductCodeId",
"required": true,
"description": "Unique identifier for the AccountProductCode object.",
"schema": {
"type": "integer",
"example": 21
},
"in": "path"
},
{
"name": "effective",
"in": "query",
"required": false,
"description": "Effective date and time used to determine which package service price plan is available. Defaults to the current UTC date and time when omitted.",
"schema": {
"type": "string",
"format": "date-time",
"example": "2026-03-28T00:00:00Z"
}
}
],
"description": "Returns the package service price plan that is available for the specified account and account product code at the supplied effective date."
}
},
"/Package/Service/PricePlan/{id}/DiscountRank": {
"put": {
"operationId": "PUT_Package_Service_PricePlan_id_DiscountRank",
"summary": "Re-arrange the order of the Package Service Price Plan Discounts.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a DiscountRank for PackageServicePricePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PackageServicePricePlanParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Package Service Price Plan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "The Rank defined based on the order of the discounts will be used to identify the priority. This API is expecting all the Package Service Price Plan Discount ids to be passed in order of priority."
}
},
"/Payment": {
"get": {
"operationId": "GET_Payment",
"summary": "List Payment records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Payment",
"summary": "Create a Payment record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Payment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
}
}
},
"/Payment/Paged": {
"get": {
"operationId": "GET_Payment_Paged",
"summary": "List Payment records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/Paged/Detail": {
"get": {
"operationId": "GET_Payment_Paged_Detail",
"summary": "List Payment records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Payment"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/{id}": {
"get": {
"operationId": "GET_Payment_id",
"summary": "Retrieve a Payment record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Payment"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Payment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Payment_id",
"summary": "Update a Payment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Payment"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Payment_id",
"summary": "Patch a Payment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Payment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Payment_id",
"summary": "Delete a Payment record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Payment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/{id}/Detail": {
"get": {
"operationId": "GET_Payment_id_Detail",
"summary": "Retrieve a Payment record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Payment"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Payment object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/Vendor": {
"post": {
"operationId": "POST_Payment_Vendor",
"summary": "Create a Payment to be processed by a specified Payment gateway vendor. Payment details provided in body of POST request.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Payment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
}
}
},
"/Payment/Reverse": {
"post": {
"operationId": "POST_Payment_Reverse",
"summary": "Reverse an existing Payment. Payment details provided in body of POST request.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Payment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
}
}
},
"/Payment/Reverse/Vendor": {
"post": {
"operationId": "POST_Payment_Reverse_Vendor",
"summary": "Reverse an existing Payment. Payment details provided in body of POST request.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Payment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
}
}
},
"/Payment/Import/Adyen": {
"post": {
"operationId": "POST_Payment_Import_Adyen",
"summary": "Create a Payment record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Payment"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Payment"
}
]
}
}
}
}
}
},
"/Payment/ActionType": {
"get": {
"operationId": "GET_Payment_ActionType",
"summary": "List PaymentActionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentActionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/ActionType/Paged": {
"get": {
"operationId": "GET_Payment_ActionType_Paged",
"summary": "List PaymentActionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentActionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/ActionType/{id}": {
"get": {
"operationId": "GET_Payment_ActionType_id",
"summary": "Retrieve a PaymentActionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentActionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentActionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/DunningRule": {
"get": {
"operationId": "GET_Payment_DunningRule",
"summary": "List PaymentDunningRule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentDunningRule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Payment_DunningRule",
"summary": "Create a PaymentDunningRule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentDunningRule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDunningRule"
}
]
}
}
}
}
}
},
"/Payment/DunningRule/Paged": {
"get": {
"operationId": "GET_Payment_DunningRule_Paged",
"summary": "List PaymentDunningRule records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentDunningRule"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/DunningRule/Paged/Detail": {
"get": {
"operationId": "GET_Payment_DunningRule_Paged_Detail",
"summary": "List PaymentDunningRule records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentDunningRule"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/DunningRule/{id}": {
"get": {
"operationId": "GET_Payment_DunningRule_id",
"summary": "Retrieve a PaymentDunningRule record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentDunningRule"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentDunningRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Payment_DunningRule_id",
"summary": "Update a PaymentDunningRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PaymentDunningRule"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDunningRule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Payment_DunningRule_id",
"summary": "Patch a PaymentDunningRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentDunningRule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentDunningRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Payment_DunningRule_id",
"summary": "Delete a PaymentDunningRule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentDunningRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/DunningRule/{id}/Detail": {
"get": {
"operationId": "GET_Payment_DunningRule_id_Detail",
"summary": "Retrieve a PaymentDunningRule record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentDunningRule"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentDunningRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentPreAuthorize": {
"get": {
"operationId": "GET_PaymentPreAuthorize",
"summary": "List PaymentPreAuthorize records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentPreAuthorize"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_PaymentPreAuthorize",
"summary": "Create a PaymentPreAuthorize record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentPreAuthorize"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentPreAuthorize"
}
]
}
}
}
},
"description": " This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified)."
}
},
"/PaymentPreAuthorize/Paged": {
"get": {
"operationId": "GET_PaymentPreAuthorize_Paged",
"summary": "List PaymentPreAuthorize records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentPreAuthorize"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentPreAuthorize/{id}": {
"get": {
"operationId": "GET_PaymentPreAuthorize_id",
"summary": "Retrieve a PaymentPreAuthorize record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentPreAuthorize"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentPreAuthorize object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentPreAuthorize/Capture": {
"post": {
"operationId": "POST_PaymentPreAuthorize_Capture",
"summary": "Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentPreAuthorize"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentPreAuthorize"
}
]
}
}
}
}
}
},
"/Payment/Term": {
"get": {
"operationId": "GET_Payment_Term",
"summary": "List PaymentTerm records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentTerm"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Payment_Term",
"summary": "Create a PaymentTerm record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentTerm"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentTerm"
}
]
}
}
}
}
}
},
"/Payment/Term/Paged": {
"get": {
"operationId": "GET_Payment_Term_Paged",
"summary": "List PaymentTerm records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentTerm"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/Term/{id}": {
"get": {
"operationId": "GET_Payment_Term_id",
"summary": "Retrieve a PaymentTerm record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentTerm"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentTerm object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Payment_Term_id",
"summary": "Update a PaymentTerm record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PaymentTerm"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentTerm"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Payment_Term_id",
"summary": "Delete a PaymentTerm record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentTerm object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/TermType": {
"get": {
"operationId": "GET_Payment_TermType",
"summary": "List PaymentTermType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentTermType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/TermType/Paged": {
"get": {
"operationId": "GET_Payment_TermType_Paged",
"summary": "List PaymentTermType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentTermType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/TermType/{id}": {
"get": {
"operationId": "GET_Payment_TermType_id",
"summary": "Retrieve a PaymentTermType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentTermType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentTermType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/BaseType": {
"get": {
"operationId": "GET_Payment_BaseType",
"summary": "List PaymentBaseType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentBaseType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/BaseType/Paged": {
"get": {
"operationId": "GET_Payment_BaseType_Paged",
"summary": "List PaymentBaseType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentBaseType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/BaseType/{id}": {
"get": {
"operationId": "GET_Payment_BaseType_id",
"summary": "Retrieve a PaymentBaseType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentBaseType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentBaseType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentGateway": {
"get": {
"operationId": "GET_PaymentGateway",
"summary": "List PaymentGateway records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentGateway"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentGateway/Paged": {
"get": {
"operationId": "GET_PaymentGateway_Paged",
"summary": "List PaymentGateway records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentGateway"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentGateway/{id}": {
"get": {
"operationId": "GET_PaymentGateway_id",
"summary": "Retrieve a PaymentGateway record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentGateway"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentGateway object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentGateway/{id}/Detail": {
"get": {
"operationId": "GET_PaymentGateway_id_Detail",
"summary": "Retrieve a PaymentGateway record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentGateway"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentGateway object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentMethod": {
"get": {
"operationId": "GET_PaymentMethod",
"summary": "List PaymentMethod records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentMethod"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentMethod/Paged": {
"get": {
"operationId": "GET_PaymentMethod_Paged",
"summary": "List PaymentMethod records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentMethod"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentMethod/{id}": {
"get": {
"operationId": "GET_PaymentMethod_id",
"summary": "Retrieve a PaymentMethod record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentMethod"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentMethod object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_PaymentMethod_id",
"summary": "Update a PaymentMethod record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PaymentMethod"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethod"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_PaymentMethod_id",
"summary": "Delete a PaymentMethod record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentMethod object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentMethod/CreditCard": {
"post": {
"operationId": "POST_PaymentMethod_CreditCard",
"summary": "Create a Credit Card type of Payment Method.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentMethod"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethod"
}
]
}
}
}
},
"description": " Used in conjunction with the Spreedly Hosted Payment Page that will tokenize the card info for PCI compliance."
}
},
"/PaymentMethod/BankAccount": {
"post": {
"operationId": "POST_PaymentMethod_BankAccount",
"summary": "Create a Debit type of PaymentMethod.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentMethod"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethod"
}
]
}
}
}
}
}
},
"/PaymentMethod/Import": {
"post": {
"operationId": "POST_PaymentMethod_Import",
"summary": "Used to Import PaymentMethod objects that have already been created and persisted in Spreedly.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentMethod"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethod"
}
]
}
}
}
}
}
},
"/PaymentMethod/Import/Sync": {
"post": {
"operationId": "POST_PaymentMethod_Import_Sync",
"summary": "Used to Import PaymentMethod objects that have already been created and persisted in Spreedly.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentMethod"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethod"
}
]
}
}
}
}
}
},
"/PaymentMethod/{id}/SetAsDefault": {
"post": {
"operationId": "POST_PaymentMethod_id_SetAsDefault",
"summary": "Set the specified payment method as the default payment method for the account.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Payment method successfully set as the default for the account."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentMethod object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Marks the payment method as the default for the account. This automatically disables AutoPay on any other payment method for the same account and enables AutoPay for billing and customer portal use."
}
},
"/PaymentStatusType": {
"get": {
"operationId": "GET_PaymentStatusType",
"summary": "List PaymentStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentStatusType/Paged": {
"get": {
"operationId": "GET_PaymentStatusType_Paged",
"summary": "List PaymentStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentStatusType/{id}": {
"get": {
"operationId": "GET_PaymentStatusType_id",
"summary": "Retrieve a PaymentStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Payment/TransactionType": {
"get": {
"operationId": "GET_Payment_TransactionType",
"summary": "List PaymentTransactionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentTransactionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/TransactionType/Paged": {
"get": {
"operationId": "GET_Payment_TransactionType_Paged",
"summary": "List PaymentTransactionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentTransactionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Payment/TransactionType/{id}": {
"get": {
"operationId": "GET_Payment_TransactionType_id",
"summary": "Retrieve a PaymentTransactionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentTransactionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentTransactionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentType": {
"get": {
"operationId": "GET_PaymentType",
"summary": "List PaymentType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentType/Paged": {
"get": {
"operationId": "GET_PaymentType_Paged",
"summary": "List PaymentType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PaymentType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PaymentType/{id}": {
"get": {
"operationId": "GET_PaymentType_id",
"summary": "Retrieve a PaymentType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PaymentType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_PaymentType_id",
"summary": "Update a PaymentType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PaymentType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_PaymentType_id",
"summary": "Delete a PaymentType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PaymentType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PaymentType/Record": {
"post": {
"operationId": "POST_PaymentType_Record",
"summary": "Create a PaymentType that is not associated with a Payment Gateway.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PaymentType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentType"
}
]
}
}
}
},
"description": " PaymentTypes are generally 'auto' created when a payment gateway is configured in the system. This API can be used to create a PaymentType for non-gateway transactions. This would be used when LogiSense Billing is not used to collect the payment, but instead log a record of the payment to reflect the account balances."
}
},
"/PaymentType/Record/{id}": {
"put": {
"operationId": "PUT_PaymentType_Record_id",
"summary": "Update the PaymentType record based on the record id",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PaymentType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PaymentTypeRecordIdParam"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceBook": {
"get": {
"operationId": "GET_PriceBook",
"summary": "List PriceBook records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceBook"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_PriceBook",
"summary": "Create a PriceBook record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PriceBook"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBook"
}
]
}
}
}
}
}
},
"/PriceBook/Paged": {
"get": {
"operationId": "GET_PriceBook_Paged",
"summary": "List PriceBook records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceBook"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceBook/Paged/Detail": {
"get": {
"operationId": "GET_PriceBook_Paged_Detail",
"summary": "List PriceBook records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceBook"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceBook/{id}": {
"get": {
"operationId": "GET_PriceBook_id",
"summary": "Retrieve a PriceBook record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceBook"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBook object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_PriceBook_id",
"summary": "Update a PriceBook record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PriceBook"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBook"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_PriceBook_id",
"summary": "Patch a PriceBook record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBook"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBook object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_PriceBook_id",
"summary": "Delete a PriceBook record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBook object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceBook/{id}/Detail": {
"get": {
"operationId": "GET_PriceBook_id_Detail",
"summary": "Retrieve a PriceBook record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceBook"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBook object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceBook/Region": {
"get": {
"operationId": "GET_PriceBook_Region",
"summary": "List PriceBookRegion records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_PriceBook_Region",
"summary": "Create a PriceBookRegion record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PriceBookRegion"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBookRegion"
}
]
}
}
}
}
}
},
"/PriceBook/Region/Paged": {
"get": {
"operationId": "GET_PriceBook_Region_Paged",
"summary": "List PriceBookRegion records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceBook/Region/Paged/Detail": {
"get": {
"operationId": "GET_PriceBook_Region_Paged_Detail",
"summary": "List PriceBookRegion records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceBook/Region/{id}": {
"get": {
"operationId": "GET_PriceBook_Region_id",
"summary": "Retrieve a PriceBookRegion record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBookRegion object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_PriceBook_Region_id",
"summary": "Update a PriceBookRegion record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PriceBookRegion"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBookRegion"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_PriceBook_Region_id",
"summary": "Patch a PriceBookRegion record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceBookRegion"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBookRegion object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_PriceBook_Region_id",
"summary": "Delete a PriceBookRegion record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBookRegion object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceBook/Region/{id}/Detail": {
"get": {
"operationId": "GET_PriceBook_Region_id_Detail",
"summary": "Retrieve a PriceBookRegion record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceBookRegion"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceBookRegion object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChange": {
"get": {
"operationId": "GET_PriceChange",
"summary": "List PriceChange records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceChange"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_PriceChange",
"summary": "Create a PriceChange record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a PriceChange"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceChange"
}
]
}
}
}
}
}
},
"/PriceChange/Paged": {
"get": {
"operationId": "GET_PriceChange_Paged",
"summary": "List PriceChange records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChange"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChange/Paged/Detail": {
"get": {
"operationId": "GET_PriceChange_Paged_Detail",
"summary": "List PriceChange records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChange"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChange/{id}": {
"get": {
"operationId": "GET_PriceChange_id",
"summary": "Retrieve a PriceChange record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChange"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_PriceChange_id",
"summary": "Update a PriceChange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a PriceChange"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceChange"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_PriceChange_id",
"summary": "Patch a PriceChange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PriceChange"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_PriceChange_id",
"summary": "Delete a PriceChange record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChange/{id}/Detail": {
"get": {
"operationId": "GET_PriceChange_id_Detail",
"summary": "Retrieve a PriceChange record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChange"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChange/{id}/Process": {
"post": {
"operationId": "POST_PriceChange_id_Process",
"summary": "Process the specified price change.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Price change processing request created successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Starts processing for the specified price change."
}
},
"/PriceChange/{id}/Approve": {
"post": {
"operationId": "POST_PriceChange_id_Approve",
"summary": "Approve the specified price change.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Price change approved successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Approves the specified price change."
}
},
"/PriceChange/{id}/Rollback": {
"post": {
"operationId": "POST_PriceChange_id_Rollback",
"summary": "Rollback the specified price change.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Price change rollback request created successfully."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Rolls back the specified price change."
}
},
"/PriceChange/{id}/Pricing/Paged/Detail": {
"get": {
"operationId": "GET_PriceChange_id_Pricing_Paged_Detail",
"summary": "List Pricing records for the specified PriceChange with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Pricing"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChange object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChangeCriteriaPriceType": {
"get": {
"operationId": "GET_PriceChangeCriteriaPriceType",
"summary": "List PriceChangeCriteriaPriceType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceChangeCriteriaPriceType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeCriteriaPriceType/Paged": {
"get": {
"operationId": "GET_PriceChangeCriteriaPriceType_Paged",
"summary": "List PriceChangeCriteriaPriceType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChangeCriteriaPriceType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeCriteriaPriceType/{id}": {
"get": {
"operationId": "GET_PriceChangeCriteriaPriceType_id",
"summary": "Retrieve a PriceChangeCriteriaPriceType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChangeCriteriaPriceType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChangeCriteriaPriceType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChangeStatusType": {
"get": {
"operationId": "GET_PriceChangeStatusType",
"summary": "List PriceChangeStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceChangeStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeStatusType/Paged": {
"get": {
"operationId": "GET_PriceChangeStatusType_Paged",
"summary": "List PriceChangeStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChangeStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeStatusType/{id}": {
"get": {
"operationId": "GET_PriceChangeStatusType_id",
"summary": "Retrieve a PriceChangeStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChangeStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChangeStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChangeTracking": {
"get": {
"operationId": "GET_PriceChangeTracking",
"summary": "List PriceChangeTracking records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceChangeTracking"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeTracking/Paged": {
"get": {
"operationId": "GET_PriceChangeTracking_Paged",
"summary": "List PriceChangeTracking records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChangeTracking"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeTracking/{id}": {
"get": {
"operationId": "GET_PriceChangeTracking_id",
"summary": "Retrieve a PriceChangeTracking record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChangeTracking"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChangeTracking object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PriceChangeType": {
"get": {
"operationId": "GET_PriceChangeType",
"summary": "List PriceChangeType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceChangeType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeType/Paged": {
"get": {
"operationId": "GET_PriceChangeType_Paged",
"summary": "List PriceChangeType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PriceChangeType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PriceChangeType/{id}": {
"get": {
"operationId": "GET_PriceChangeType_id",
"summary": "Retrieve a PriceChangeType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PriceChangeType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PriceChangeType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PricePlan/TierType": {
"get": {
"operationId": "GET_PricePlan_TierType",
"summary": "List PricePlanTierType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricePlanTierType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PricePlan/TierType/Paged": {
"get": {
"operationId": "GET_PricePlan_TierType_Paged",
"summary": "List PricePlanTierType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PricePlanTierType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PricePlan/TierType/{id}": {
"get": {
"operationId": "GET_PricePlan_TierType_id",
"summary": "Retrieve a PricePlanTierType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PricePlanTierType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PricePlanTierType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/PricePlan/Type": {
"get": {
"operationId": "GET_PricePlan_Type",
"summary": "List PricePlanType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricePlanType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PricePlan/Type/Paged": {
"get": {
"operationId": "GET_PricePlan_Type_Paged",
"summary": "List PricePlanType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/PricePlanType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/PricePlan/Type/{id}": {
"get": {
"operationId": "GET_PricePlan_Type_id",
"summary": "Retrieve a PricePlanType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/PricePlanType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the PricePlanType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/RatePlan": {
"get": {
"operationId": "GET_RatePlan",
"summary": "List RatePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_RatePlan",
"summary": "Create a RatePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a RatePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RatePlan"
}
]
}
}
}
}
}
},
"/RatePlan/Paged": {
"get": {
"operationId": "GET_RatePlan_Paged",
"summary": "List RatePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/RatePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RatePlan/Paged/Detail": {
"get": {
"operationId": "GET_RatePlan_Paged_Detail",
"summary": "List RatePlan records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/RatePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RatePlan/{id}": {
"get": {
"operationId": "GET_RatePlan_id",
"summary": "Retrieve a RatePlan record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/RatePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_RatePlan_id",
"summary": "Update a RatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a RatePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RatePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_RatePlan_id",
"summary": "Patch a RatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RatePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_RatePlan_id",
"summary": "Delete a RatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/RatePlan/{id}/Detail": {
"get": {
"operationId": "GET_RatePlan_id_Detail",
"summary": "Retrieve a RatePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/RatePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ReportDefinition": {
"get": {
"operationId": "GET_ReportDefinition",
"summary": "List ReportDefinition records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportDefinition"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ReportDefinition/Paged": {
"get": {
"operationId": "GET_ReportDefinition_Paged",
"summary": "List ReportDefinition records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ReportDefinition"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ReportDefinition/{id}": {
"get": {
"operationId": "GET_ReportDefinition_id",
"summary": "Retrieve a ReportDefinition record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ReportDefinition"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ReportDefinition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ReportDefinition/{id}/LastGenerated": {
"get": {
"operationId": "GET_ReportDefinition_id_LastGenerated",
"summary": "Return the last generated report PDF for a specified ReportDefinition regardless of how the report was generated.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportDefinitionIdLastGeneratedResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ReportDefinition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ReportDefinition/{id}/Generated": {
"get": {
"operationId": "GET_ReportDefinition_id_Generated",
"summary": "Return a list of PDFs that have been generated by a system schedule for the specified ReportDefinition.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportDefinitionIdGeneratedResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ReportDefinition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ReportDefinition/{id}/Render": {
"post": {
"operationId": "POST_ReportDefinition_id_Render",
"summary": "Queue rendering for the specified report definition.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Report rendering request accepted."
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ReportDefinition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Queues asynchronous rendering for the specified report definition and returns the result information for the accepted request."
}
},
"/ReportDefinition/{id}/DownloadLastGenerated": {
"get": {
"operationId": "GET_ReportDefinition_id_DownloadLastGenerated",
"summary": "Retrieve the last generated report for a report definition.",
"responses": {
"200": {
"description": "Last generated report download payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportStorageResult"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ReportDefinition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns stored report metadata and a direct download link for the most recently generated report for the specified report definition."
}
},
"/ReportDefinition/{id}/Download": {
"get": {
"operationId": "GET_ReportDefinition_id_Download",
"summary": "Retrieve a generated report by report storage identifier.",
"responses": {
"200": {
"description": "Stored report download payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportStorageResult"
}
}
}
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Report storage identifier for the generated report.",
"schema": {
"type": "string",
"format": "uuid",
"example": "81015f2b-e8cd-43ce-b26d-3173e181cf42"
},
"in": "path"
}
],
"description": "Returns stored report metadata and a direct download link for the specified generated report."
}
},
"/RerateSchedule": {
"get": {
"operationId": "GET_RerateSchedule",
"summary": "List RerateSchedule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RerateSchedule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RerateSchedule/Paged": {
"get": {
"operationId": "GET_RerateSchedule_Paged",
"summary": "List RerateSchedule records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/RerateSchedule"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RerateSchedule/{id}": {
"get": {
"operationId": "GET_RerateSchedule_id",
"summary": "Retrieve a RerateSchedule record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/RerateSchedule"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RerateSchedule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Rerate/Pending": {
"get": {
"operationId": "GET_Rerate_Pending",
"summary": "List ViewReratePending records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ViewReratePending"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Rerate/Pending/Paged": {
"get": {
"operationId": "GET_Rerate_Pending_Paged",
"summary": "List ViewReratePending records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ViewReratePending"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RerateScheduleTracking/ByRerateSchedule/{id}": {
"get": {
"operationId": "GET_RerateScheduleTracking_ByRerateSchedule_id",
"summary": "Retrieve a RerateScheduleTracking record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/RerateScheduleTracking"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RerateScheduleTracking object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/RerateScheduleTracking/ByRerateSchedule/{id}/Paged": {
"get": {
"operationId": "GET_RerateScheduleTracking_ByRerateSchedule_id_Paged",
"summary": "List / records for the specified RerateScheduleTracking with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/CustomDataSource"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RerateScheduleTracking object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Rerate/Now": {
"post": {
"operationId": "POST_Rerate_Now",
"summary": "Queue rerating for a single account.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"description": "Rerate request accepted and queued successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RerateNowParam"
}
}
}
},
"description": "Creates rerate work for a single account identified by accountId or accountName."
}
},
"/Rerate/Now/Batch": {
"post": {
"operationId": "POST_Rerate_Now_Batch",
"summary": "Queue rerating for multiple accounts in a single request.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Rerate batch accepted and queued successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RerateNowBatchParam"
}
}
}
},
"description": "Creates rerate work for the accounts provided in the batch payload. Each item can identify an account by ID or by a unique account name and can optionally override the rerate start date."
}
},
"/RoundingMethodType": {
"get": {
"operationId": "GET_RoundingMethodType",
"summary": "List RoundingMethodType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoundingMethodType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RoundingMethodType/Paged": {
"get": {
"operationId": "GET_RoundingMethodType_Paged",
"summary": "List RoundingMethodType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/RoundingMethodType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/RoundingMethodType/{id}": {
"get": {
"operationId": "GET_RoundingMethodType_id",
"summary": "Retrieve a RoundingMethodType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/RoundingMethodType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the RoundingMethodType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Schedule/BillRun": {
"post": {
"operationId": "POST_Schedule_BillRun",
"summary": "Create a Schedule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Schedule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
}
}
}
}
}
},
"/Schedule/Rerate": {
"get": {
"operationId": "GET_Schedule_Rerate",
"summary": "List Schedule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schedule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Schedule_Rerate",
"summary": "Create a Schedule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Schedule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
}
}
}
}
}
},
"/Schedule/Rerate/{id}": {
"put": {
"operationId": "PUT_Schedule_Rerate_id",
"summary": "Update a Schedule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Schedule"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Schedule/DataExport": {
"get": {
"operationId": "GET_Schedule_DataExport",
"summary": "List Schedule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Schedule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Schedule_DataExport",
"summary": "Create a Schedule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Schedule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
}
}
}
}
}
},
"/Schedule/DataExport/{id}": {
"put": {
"operationId": "PUT_Schedule_DataExport_id",
"summary": "Update a Schedule record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Schedule"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Schedule"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service": {
"get": {
"operationId": "GET_Service",
"summary": "List Service records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Service",
"summary": "Create a Service record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Service"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Service"
}
]
}
}
}
}
}
},
"/Service/Paged": {
"get": {
"operationId": "GET_Service_Paged",
"summary": "List Service records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/Paged/Detail": {
"get": {
"operationId": "GET_Service_Paged_Detail",
"summary": "List Service records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/{id}": {
"get": {
"operationId": "GET_Service_id",
"summary": "Retrieve a Service record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Service"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Service_id",
"summary": "Update a Service record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Service"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Service"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Service_id",
"summary": "Patch a Service record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Service"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Service_id",
"summary": "Delete a Service record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/{id}/Detail": {
"get": {
"operationId": "GET_Service_id_Detail",
"summary": "Retrieve a Service record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Service"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/AvailableFor/SharePlans": {
"get": {
"operationId": "GET_Service_AvailableFor_SharePlans",
"summary": "Retrieve services available for share plan configuration.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
}
]
}
}
},
"description": "List of services available for share plan configuration."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns services that can be configured on share plans."
}
},
"/Service/BaseType": {
"get": {
"operationId": "GET_Service_BaseType",
"summary": "List ServiceBaseType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceBaseType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/BaseType/Paged": {
"get": {
"operationId": "GET_Service_BaseType_Paged",
"summary": "List ServiceBaseType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceBaseType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/BaseType/{id}": {
"get": {
"operationId": "GET_Service_BaseType_id",
"summary": "Retrieve a ServiceBaseType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceBaseType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceBaseType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/Category": {
"get": {
"operationId": "GET_Service_Category",
"summary": "List ServiceCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/Category/Paged": {
"get": {
"operationId": "GET_Service_Category_Paged",
"summary": "List ServiceCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/Category/{id}": {
"get": {
"operationId": "GET_Service_Category_id",
"summary": "Retrieve a ServiceCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/StatusType": {
"get": {
"operationId": "GET_Service_StatusType",
"summary": "List ServiceStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Service_StatusType",
"summary": "Create a ServiceStatusType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ServiceStatusType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceStatusType"
}
]
}
}
}
}
}
},
"/Service/StatusType/Paged": {
"get": {
"operationId": "GET_Service_StatusType_Paged",
"summary": "List ServiceStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/StatusType/{id}": {
"get": {
"operationId": "GET_Service_StatusType_id",
"summary": "Retrieve a ServiceStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Service_StatusType_id",
"summary": "Update a ServiceStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ServiceStatusType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceStatusType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Service_StatusType_id",
"summary": "Delete a ServiceStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/TaxCategory": {
"get": {
"operationId": "GET_Service_TaxCategory",
"summary": "List ServiceTaxCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTaxCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Service_TaxCategory",
"summary": "Create a ServiceTaxCategory record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ServiceTaxCategory"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceTaxCategory"
}
]
}
}
}
}
}
},
"/Service/TaxCategory/Paged": {
"get": {
"operationId": "GET_Service_TaxCategory_Paged",
"summary": "List ServiceTaxCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceTaxCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/TaxCategory/{id}": {
"get": {
"operationId": "GET_Service_TaxCategory_id",
"summary": "Retrieve a ServiceTaxCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceTaxCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceTaxCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Service_TaxCategory_id",
"summary": "Update a ServiceTaxCategory record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ServiceTaxCategory"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceTaxCategory"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Service_TaxCategory_id",
"summary": "Delete a ServiceTaxCategory record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceTaxCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Service/TaxCategory/AvaTax": {
"get": {
"operationId": "GET_Service_TaxCategory_AvaTax",
"summary": "List ServiceTaxCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTaxCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/Transition": {
"get": {
"operationId": "GET_Service_Transition",
"summary": "List ServiceTransition records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceTransition"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Service_Transition",
"summary": "Create a ServiceTransition record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ServiceTransition"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceTransition"
}
]
}
}
}
}
}
},
"/Service/Transition/Paged": {
"get": {
"operationId": "GET_Service_Transition_Paged",
"summary": "List ServiceTransition records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceTransition"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Service/Transition/{id}": {
"get": {
"operationId": "GET_Service_Transition_id",
"summary": "Retrieve a ServiceTransition record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceTransition"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceTransition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Service_Transition_id",
"summary": "Update a ServiceTransition record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ServiceTransition"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceTransition"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Service_Transition_id",
"summary": "Delete a ServiceTransition record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceTransition object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/ServiceType": {
"get": {
"operationId": "GET_ServiceType",
"summary": "List ServiceType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_ServiceType",
"summary": "Create a ServiceType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a ServiceType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceType"
}
]
}
}
}
}
}
},
"/ServiceType/Paged": {
"get": {
"operationId": "GET_ServiceType_Paged",
"summary": "List ServiceType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/ServiceType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/ServiceType/{id}": {
"get": {
"operationId": "GET_ServiceType_id",
"summary": "Retrieve a ServiceType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ServiceType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_ServiceType_id",
"summary": "Update a ServiceType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a ServiceType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_ServiceType_id",
"summary": "Delete a ServiceType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the ServiceType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/SharePlanType": {
"get": {
"operationId": "GET_SharePlanType",
"summary": "List SharePlanType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePlanType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/SharePlanType/Paged": {
"get": {
"operationId": "GET_SharePlanType_Paged",
"summary": "List SharePlanType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/SharePlanType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/SharePlanType/{id}": {
"get": {
"operationId": "GET_SharePlanType_id",
"summary": "Retrieve a SharePlanType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/SharePlanType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the SharePlanType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/State": {
"get": {
"operationId": "GET_State",
"summary": "List State records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/State"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/State/Paged": {
"get": {
"operationId": "GET_State_Paged",
"summary": "List State records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/State"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/State/{id}": {
"get": {
"operationId": "GET_State_id",
"summary": "Retrieve a State record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/State"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the State object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/StatusTierType": {
"get": {
"operationId": "GET_StatusTierType",
"summary": "List StatusTierType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusTierType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/StatusTierType/Paged": {
"get": {
"operationId": "GET_StatusTierType_Paged",
"summary": "List StatusTierType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/StatusTierType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/StatusTierType/{id}": {
"get": {
"operationId": "GET_StatusTierType_id",
"summary": "Retrieve a StatusTierType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/StatusTierType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the StatusTierType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/StatusType": {
"get": {
"operationId": "GET_StatusType",
"summary": "List StatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/StatusType/Paged": {
"get": {
"operationId": "GET_StatusType_Paged",
"summary": "List StatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/StatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/StatusType/{id}": {
"get": {
"operationId": "GET_StatusType_id",
"summary": "Retrieve a StatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/StatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the StatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Category": {
"get": {
"operationId": "GET_Tax_Category",
"summary": "List TaxCategory records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCategory"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Category/Paged": {
"get": {
"operationId": "GET_Tax_Category_Paged",
"summary": "List TaxCategory records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxCategory"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Category/{id}": {
"get": {
"operationId": "GET_Tax_Category_id",
"summary": "Retrieve a TaxCategory record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxCategory"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxCategory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Code": {
"get": {
"operationId": "GET_Tax_Code",
"summary": "List TaxCode records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxCode"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Tax_Code",
"summary": "Create a TaxCode record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a TaxCode"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxCode"
}
]
}
}
}
}
}
},
"/Tax/Code/Paged": {
"get": {
"operationId": "GET_Tax_Code_Paged",
"summary": "List TaxCode records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxCode"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Code/Paged/Detail": {
"get": {
"operationId": "GET_Tax_Code_Paged_Detail",
"summary": "List TaxCode records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxCode"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Code/{id}": {
"get": {
"operationId": "GET_Tax_Code_id",
"summary": "Retrieve a TaxCode record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxCode"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Tax_Code_id",
"summary": "Update a TaxCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a TaxCode"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxCode"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Tax_Code_id",
"summary": "Patch a TaxCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxCode"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Tax_Code_id",
"summary": "Delete a TaxCode record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Code/{id}/Detail": {
"get": {
"operationId": "GET_Tax_Code_id_Detail",
"summary": "Retrieve a TaxCode record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxCode"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxCode object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/ExemptLevel": {
"get": {
"operationId": "GET_Tax_ExemptLevel",
"summary": "List TaxExemptLevel records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxExemptLevel"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/ExemptLevel/Paged": {
"get": {
"operationId": "GET_Tax_ExemptLevel_Paged",
"summary": "List TaxExemptLevel records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxExemptLevel"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/ExemptLevel/{id}": {
"get": {
"operationId": "GET_Tax_ExemptLevel_id",
"summary": "Retrieve a TaxExemptLevel record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxExemptLevel"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxExemptLevel object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/ExemptType": {
"get": {
"operationId": "GET_Tax_ExemptType",
"summary": "List TaxExemptType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxExemptType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/ExemptType/Paged": {
"get": {
"operationId": "GET_Tax_ExemptType_Paged",
"summary": "List TaxExemptType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxExemptType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/ExemptType/{id}": {
"get": {
"operationId": "GET_Tax_ExemptType_id",
"summary": "Retrieve a TaxExemptType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxExemptType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxExemptType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Rate": {
"get": {
"operationId": "GET_Tax_Rate",
"summary": "List TaxRate records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxRate"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Tax_Rate",
"summary": "Create a TaxRate record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a TaxRate"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxRate"
}
]
}
}
}
}
}
},
"/Tax/Rate/Paged": {
"get": {
"operationId": "GET_Tax_Rate_Paged",
"summary": "List TaxRate records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxRate"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Rate/{id}": {
"get": {
"operationId": "GET_Tax_Rate_id",
"summary": "Retrieve a TaxRate record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxRate"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Tax_Rate_id",
"summary": "Update a TaxRate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a TaxRate"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxRate"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Tax_Rate_id",
"summary": "Delete a TaxRate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Type": {
"get": {
"operationId": "GET_Tax_Type",
"summary": "List TaxType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Type/Paged": {
"get": {
"operationId": "GET_Tax_Type_Paged",
"summary": "List TaxType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Type/{id}": {
"get": {
"operationId": "GET_Tax_Type_id",
"summary": "Retrieve a TaxType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Vendor": {
"get": {
"operationId": "GET_Tax_Vendor",
"summary": "List TaxVendor records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxVendor"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Tax_Vendor",
"summary": "Create a TaxVendor record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a TaxVendor"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxVendor"
}
]
}
}
}
}
}
},
"/Tax/Vendor/Paged": {
"get": {
"operationId": "GET_Tax_Vendor_Paged",
"summary": "List TaxVendor records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxVendor"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/{id}": {
"get": {
"operationId": "GET_Tax_Vendor_id",
"summary": "Retrieve a TaxVendor record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxVendor"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxVendor object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Tax_Vendor_id",
"summary": "Update a TaxVendor record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a TaxVendor"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/TaxVendor"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Tax_Vendor_id",
"summary": "Delete a TaxVendor record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxVendor object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Vendor/Business/Class": {
"get": {
"operationId": "GET_Tax_Vendor_Business_Class",
"summary": "List TaxVendorBusinessClass records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxVendorBusinessClass"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Business/Class/Paged": {
"get": {
"operationId": "GET_Tax_Vendor_Business_Class_Paged",
"summary": "List TaxVendorBusinessClass records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxVendorBusinessClass"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Business/Class/{id}": {
"get": {
"operationId": "GET_Tax_Vendor_Business_Class_id",
"summary": "Retrieve a TaxVendorBusinessClass record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxVendorBusinessClass"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxVendorBusinessClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Vendor/Service/Class": {
"get": {
"operationId": "GET_Tax_Vendor_Service_Class",
"summary": "List TaxVendorServiceClass records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxVendorServiceClass"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Service/Class/Paged": {
"get": {
"operationId": "GET_Tax_Vendor_Service_Class_Paged",
"summary": "List TaxVendorServiceClass records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxVendorServiceClass"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Service/Class/{id}": {
"get": {
"operationId": "GET_Tax_Vendor_Service_Class_id",
"summary": "Retrieve a TaxVendorServiceClass record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxVendorServiceClass"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxVendorServiceClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Vendor/Type": {
"get": {
"operationId": "GET_Tax_Vendor_Type",
"summary": "List TaxVendorType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxVendorType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Type/Paged": {
"get": {
"operationId": "GET_Tax_Vendor_Type_Paged",
"summary": "List TaxVendorType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxVendorType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Vendor/Type/{id}": {
"get": {
"operationId": "GET_Tax_Vendor_Type_id",
"summary": "Retrieve a TaxVendorType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxVendorType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxVendorType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Tax/Rate/CalculationType": {
"get": {
"operationId": "GET_Tax_Rate_CalculationType",
"summary": "List TaxRateCalculationType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxRateCalculationType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Rate/CalculationType/Paged": {
"get": {
"operationId": "GET_Tax_Rate_CalculationType_Paged",
"summary": "List TaxRateCalculationType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TaxRateCalculationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Tax/Rate/CalculationType/{id}": {
"get": {
"operationId": "GET_Tax_Rate_CalculationType_id",
"summary": "Retrieve a TaxRateCalculationType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TaxRateCalculationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TaxRateCalculationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Template": {
"get": {
"operationId": "GET_Template",
"summary": "List Template records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Template/Paged": {
"get": {
"operationId": "GET_Template_Paged",
"summary": "List Template records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Template"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Template/{id}": {
"get": {
"operationId": "GET_Template_id",
"summary": "Retrieve a Template record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Template"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Template object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Template_id",
"summary": "Delete a Template record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Template object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Template/{id}/Detail": {
"get": {
"operationId": "GET_Template_id_Detail",
"summary": "Retrieve a Template record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Template"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Template object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Template/CreditNote": {
"post": {
"operationId": "POST_Template_CreditNote",
"summary": "Create a Template record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Template"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Template"
}
]
}
}
}
}
}
},
"/Template/CreditNote/{id}": {
"put": {
"operationId": "PUT_Template_CreditNote_id",
"summary": "Update a Template record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Template"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Template"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Template/Invoice": {
"post": {
"operationId": "POST_Template_Invoice",
"summary": "Create a Template record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Template"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Template"
}
]
}
}
}
}
}
},
"/Template/Invoice/{id}": {
"put": {
"operationId": "PUT_Template_Invoice_id",
"summary": "Update a Template record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Template"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Template"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Template_Invoice_id",
"summary": "Patch a Template record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Template"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Template object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Term": {
"get": {
"operationId": "GET_Term",
"summary": "List Term records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Term"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Term",
"summary": "Create a Term record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a Term"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Term"
}
]
}
}
}
}
}
},
"/Term/Paged": {
"get": {
"operationId": "GET_Term_Paged",
"summary": "List Term records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Term"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Term/Paged/Detail": {
"get": {
"operationId": "GET_Term_Paged_Detail",
"summary": "List Term records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/Term"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Term/{id}": {
"get": {
"operationId": "GET_Term_id",
"summary": "Retrieve a Term record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Term"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Term object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Term_id",
"summary": "Update a Term record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a Term"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Term"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Term_id",
"summary": "Patch a Term record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Term"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Term object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Term_id",
"summary": "Delete a Term record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Term object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Term/{id}/Detail": {
"get": {
"operationId": "GET_Term_id_Detail",
"summary": "Retrieve a Term record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/Term"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Term object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/TermType": {
"get": {
"operationId": "GET_TermType",
"summary": "List TermType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TermType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/TermType/Paged": {
"get": {
"operationId": "GET_TermType_Paged",
"summary": "List TermType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TermType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/TermType/{id}": {
"get": {
"operationId": "GET_TermType_id",
"summary": "Retrieve a TermType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TermType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TermType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/TierCalculationType": {
"get": {
"operationId": "GET_TierCalculationType",
"summary": "Retrieve tier calculation types.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TierCalculationType"
}
}
}
}
]
}
}
},
"description": "List of available tier calculation type lookup values."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns the available tier calculation type lookup values used when configuring tiered usage and pricing rules."
}
},
"/TierCalculationType/Paged": {
"get": {
"operationId": "GET_TierCalculationType_Paged",
"summary": "List TierCalculationType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TierCalculationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/TierCalculationType/{id}": {
"get": {
"operationId": "GET_TierCalculationType_id",
"summary": "Retrieve a TierCalculationType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TierCalculationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TierCalculationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/TierChargeType": {
"get": {
"operationId": "GET_TierChargeType",
"summary": "List TierChargeType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TierChargeType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/TierChargeType/Paged": {
"get": {
"operationId": "GET_TierChargeType_Paged",
"summary": "List TierChargeType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/TierChargeType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/TierChargeType/{id}": {
"get": {
"operationId": "GET_TierChargeType_id",
"summary": "Retrieve a TierChargeType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/TierChargeType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the TierChargeType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/{id}/MonthlyUsageSummary/Paged": {
"get": {
"parameters": [
{
"description": "Unique identifier of the account.",
"name": "id",
"required": true,
"schema": {
"example": 1024,
"type": "integer"
},
"in": "path"
},
{
"description": "Numeric month of usage to summarize.",
"name": "usageMonth",
"required": true,
"schema": {
"example": 3,
"type": "integer"
},
"in": "query"
},
{
"description": "Four-digit usage year to summarize.",
"name": "usageYear",
"required": true,
"schema": {
"example": 2026,
"type": "integer"
},
"in": "query"
},
{
"description": "1-based page number to return. Defaults to 1 when omitted.",
"name": "pageNumber",
"required": false,
"schema": {
"default": 1,
"example": 1,
"type": "integer"
},
"in": "query"
},
{
"description": "Maximum number of summary rows to return per page. Defaults to 20 when omitted.",
"name": "pageSize",
"required": false,
"schema": {
"default": 20,
"example": 20,
"type": "integer"
},
"in": "query"
},
{
"description": "Set to true to skip calculating the total number of matching rows.",
"name": "excludeTotalCount",
"required": false,
"schema": {
"default": false,
"example": false,
"type": "boolean"
},
"in": "query"
}
],
"summary": "Retrieve monthly aggregated usage totals for the specified account in a paged response.",
"description": "Returns monthly usage totals for a single account, grouped into summary rows such as service and package combinations. The request requires both usage month and usage year and supports standard paging parameters.",
"operationId": "GET_Account_id_MonthlyUsageSummary_Paged",
"responses": {
"200": {
"description": "Paged monthly usage summary for the requested account and billing month.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonthlyUsageSummaryPagedResponse"
}
}
}
},
"400": {
"description": "Error occurred during this request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Udr/Feed": {
"get": {
"operationId": "GET_Udr_Feed",
"summary": "List UDRFeed records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UDRFeed"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Udr/Feed/Paged": {
"get": {
"operationId": "GET_Udr_Feed_Paged",
"summary": "List UDRFeed records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UDRFeed"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Udr/Feed/{id}": {
"get": {
"operationId": "GET_Udr_Feed_id",
"summary": "Retrieve a UDRFeed record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UDRFeed"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UDRFeed object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Udr/Mediated/{id}": {
"get": {
"operationId": "GET_Udr_Mediated_id",
"summary": "Retrieve a UDRMediated record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UDRMediated"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UDRMediated object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Udr/UsageBucket": {
"get": {
"operationId": "GET_Udr_UsageBucket",
"summary": "List UDRUsageBucket records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UDRUsageBucket"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Udr/UsageBucket/Paged": {
"get": {
"operationId": "GET_Udr_UsageBucket_Paged",
"summary": "List UDRUsageBucket records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UDRUsageBucket"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Udr/UsageBucket/{id}": {
"get": {
"operationId": "GET_Udr_UsageBucket_id",
"summary": "Retrieve a UDRUsageBucket record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UDRUsageBucket"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UDRUsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/BaseUnit": {
"get": {
"operationId": "GET_Usage_BaseUnit",
"summary": "List UsageBaseUnit records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBaseUnit"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/BaseUnit/Paged": {
"get": {
"operationId": "GET_Usage_BaseUnit_Paged",
"summary": "List UsageBaseUnit records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBaseUnit"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/BaseUnit/{id}": {
"get": {
"operationId": "GET_Usage_BaseUnit_id",
"summary": "Retrieve a UsageBaseUnit record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBaseUnit"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBaseUnit object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket": {
"get": {
"operationId": "GET_Usage_Bucket",
"summary": "Retrieve usage buckets.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
}
]
}
}
},
"description": "List of usage buckets."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Returns usage buckets that match the supplied query criteria."
},
"post": {
"operationId": "POST_Usage_Bucket",
"summary": "Create a usage bucket.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Usage bucket created successfully."
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucket"
}
]
}
}
}
},
"description": "Creates a usage bucket definition."
}
},
"/Usage/Bucket/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_Paged",
"summary": "List UsageBucket records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_Paged_Detail",
"summary": "List UsageBucket records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_id",
"summary": "Retrieve a usage bucket by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
]
}
}
},
"description": "Usage bucket."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns the specified usage bucket."
},
"put": {
"operationId": "PUT_Usage_Bucket_id",
"summary": "Update a UsageBucket record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageBucket"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucket"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Bucket_id",
"summary": "Patch a usage bucket.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Usage bucket updated successfully."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucket"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Updates selected fields on the specified usage bucket."
},
"delete": {
"operationId": "DELETE_Usage_Bucket_id",
"summary": "Delete a UsageBucket record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_id_Detail",
"summary": "Retrieve a usage bucket with detail data by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucket"
}
}
}
]
}
}
},
"description": "Usage bucket with detail data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucket object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
],
"description": "Returns a single usage bucket and includes any populated detail records exposed by the usage bucket detail workflow."
}
},
"/Usage/Bucket/Base": {
"get": {
"operationId": "GET_Usage_Bucket_Base",
"summary": "List UsageBucketBase records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketBase"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Bucket_Base",
"summary": "Create a UsageBucketBase record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageBucketBase"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketBase"
}
]
}
}
}
}
}
},
"/Usage/Bucket/Base/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_Base_Paged",
"summary": "List UsageBucketBase records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketBase"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/Base/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_Base_Paged_Detail",
"summary": "List UsageBucketBase records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketBase"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/Base/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_Base_id",
"summary": "Retrieve a UsageBucketBase record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketBase"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBase object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Bucket_Base_id",
"summary": "Update a UsageBucketBase record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageBucketBase"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketBase"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Bucket_Base_id",
"summary": "Patch a UsageBucketBase record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketBase"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBase object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Bucket_Base_id",
"summary": "Delete a UsageBucketBase record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBase object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/Base/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_Base_id_Detail",
"summary": "Retrieve a UsageBucketBase record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketBase"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBase object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/BaseDetail": {
"get": {
"operationId": "GET_Usage_Bucket_BaseDetail",
"summary": "List UsageBucketBaseDetail records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketBaseDetail"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Bucket_BaseDetail",
"summary": "Create a UsageBucketBaseDetail record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageBucketBaseDetail"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketBaseDetail"
}
]
}
}
}
}
}
},
"/Usage/Bucket/BaseDetail/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_BaseDetail_Paged",
"summary": "List UsageBucketBaseDetail records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketBaseDetail"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/BaseDetail/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_BaseDetail_id",
"summary": "Retrieve a UsageBucketBaseDetail record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketBaseDetail"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBaseDetail object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Bucket_BaseDetail_id",
"summary": "Update a UsageBucketBaseDetail record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageBucketBaseDetail"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketBaseDetail"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Bucket_BaseDetail_id",
"summary": "Delete a UsageBucketBaseDetail record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBaseDetail object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/BaseUnit": {
"get": {
"operationId": "GET_Usage_Bucket_BaseUnit",
"summary": "List UsageBucketBaseUnit records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketBaseUnit"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/BaseUnit/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_BaseUnit_Paged",
"summary": "List UsageBucketBaseUnit records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketBaseUnit"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/BaseUnit/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_BaseUnit_id",
"summary": "Retrieve a UsageBucketBaseUnit record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketBaseUnit"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketBaseUnit object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/RefillType": {
"get": {
"operationId": "GET_Usage_Bucket_RefillType",
"summary": "List UsageBucketRefillType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketRefillType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/RefillType/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_RefillType_Paged",
"summary": "List UsageBucketRefillType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketRefillType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/RefillType/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_RefillType_id",
"summary": "Retrieve a UsageBucketRefillType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketRefillType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketRefillType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Bucket_RefillType_id",
"summary": "Delete a UsageBucketRefillType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketRefillType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/ShareLevel": {
"get": {
"operationId": "GET_Usage_Bucket_ShareLevel",
"summary": "List UsageBucketShareLevel records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketShareLevel"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/ShareLevel/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_ShareLevel_Paged",
"summary": "List UsageBucketShareLevel records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketShareLevel"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/ShareLevel/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_ShareLevel_id",
"summary": "Retrieve a UsageBucketShareLevel record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketShareLevel"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketShareLevel object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/SharePlan": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan",
"summary": "List UsageBucketSharePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Bucket_SharePlan",
"summary": "Create a UsageBucketSharePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageBucketSharePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
]
}
}
}
}
}
},
"/Usage/Bucket/SharePlan/ForService/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_ForService_id",
"summary": "Return the UsageBucketSharePlan objects that are related to the specified Service.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/SharePlan/ForService/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_ForService_id_Detail",
"summary": "Return the UsageBucketSharePlan object details that are related to the specified Service.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the Service object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/SharePlan/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_Paged",
"summary": "List UsageBucketSharePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/SharePlan/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_Paged_Detail",
"summary": "List UsageBucketSharePlan records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/SharePlan/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_id",
"summary": "Retrieve a UsageBucketSharePlan record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Bucket_SharePlan_id",
"summary": "Update a UsageBucketSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageBucketSharePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Bucket_SharePlan_id",
"summary": "Patch a UsageBucketSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Bucket_SharePlan_id",
"summary": "Delete a UsageBucketSharePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/SharePlan/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_id_Detail",
"summary": "Retrieve a UsageBucketSharePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketSharePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketSharePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/SharePlan/ActivationType": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_ActivationType",
"summary": "Return the UsageBucketSharePlan Activation Types.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageBucketSharePlanActivationTypeResult"
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/SharePlan/ActivationType/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_ActivationType_Paged",
"summary": "Return the UsageBucketSharePlan Activation Types.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketSharePlanActivationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/SharePlan/ActivationType/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_SharePlan_ActivationType_id",
"summary": "Return the UsageBucketSharePlan Activation Types.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketSharePlanActivationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketSharePlanActivationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Bucket/Tier": {
"get": {
"operationId": "GET_Usage_Bucket_Tier",
"summary": "List UsageBucketTier records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageBucketTier"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Bucket_Tier",
"summary": "Create a UsageBucketTier record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageBucketTier"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketTier"
}
]
}
}
}
}
}
},
"/Usage/Bucket/Tier/Paged": {
"get": {
"operationId": "GET_Usage_Bucket_Tier_Paged",
"summary": "List UsageBucketTier records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageBucketTier"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Bucket/Tier/{id}": {
"get": {
"operationId": "GET_Usage_Bucket_Tier_id",
"summary": "Retrieve a UsageBucketTier record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageBucketTier"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketTier object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Bucket_Tier_id",
"summary": "Update a UsageBucketTier record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageBucketTier"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageBucketTier"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Bucket_Tier_id",
"summary": "Delete a UsageBucketTier record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageBucketTier object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class": {
"get": {
"operationId": "GET_Usage_Class",
"summary": "List UsageClass records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageClass"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Class",
"summary": "Create a UsageClass record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageClass"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClass"
}
]
}
}
}
}
}
},
"/Usage/Class/Paged": {
"get": {
"operationId": "GET_Usage_Class_Paged",
"summary": "List UsageClass records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClass"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Class_Paged_Detail",
"summary": "List UsageClass records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClass"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/{id}": {
"get": {
"operationId": "GET_Usage_Class_id",
"summary": "Retrieve a UsageClass record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClass"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Class_id",
"summary": "Update a UsageClass record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageClass"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClass"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Class_id",
"summary": "Patch a UsageClass record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClass"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Class_id",
"summary": "Delete a UsageClass record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Class_id_Detail",
"summary": "Retrieve a UsageClass record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClass"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClass object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class/AvailableFor/RateGroup/{id}/BaseUnit/{usageBaseUnitId}": {
"get": {
"parameters": [
{
"description": "Unique identifier of the usage rate group.",
"name": "id",
"required": true,
"schema": {
"example": 220,
"type": "integer"
},
"in": "path"
},
{
"description": "Unique identifier of the usage base unit.",
"name": "usageBaseUnitId",
"required": true,
"schema": {
"example": 5,
"type": "integer"
},
"in": "path"
}
],
"summary": "Retrieve usage classes available for the specified rate group and base unit.",
"description": "Returns usage classes that are compatible with the specified usage rate group and usage base unit.",
"operationId": "GET_Usage_Class_AvailableFor_RateGroup_id_BaseUnit_usageBaseUnitId",
"responses": {
"200": {
"description": "List of usage classes available for the rate group and base unit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UsageClassListResponse"
}
}
}
},
"400": {
"description": "Error occurred during this request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Dynamic": {
"get": {
"operationId": "GET_Usage_Class_Dynamic",
"summary": "List UsageClassDynamic records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageClassDynamic"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Class_Dynamic",
"summary": "Create a UsageClassDynamic record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageClassDynamic"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClassDynamic"
}
]
}
}
}
}
}
},
"/Usage/Class/Dynamic/Paged": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_Paged",
"summary": "List UsageClassDynamic records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClassDynamic"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Dynamic/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_Paged_Detail",
"summary": "List UsageClassDynamic records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClassDynamic"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Dynamic/{id}": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_id",
"summary": "Retrieve a UsageClassDynamic record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClassDynamic"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassDynamic object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Class_Dynamic_id",
"summary": "Update a UsageClassDynamic record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageClassDynamic"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClassDynamic"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Class_Dynamic_id",
"summary": "Patch a UsageClassDynamic record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClassDynamic"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassDynamic object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Class_Dynamic_id",
"summary": "Delete a UsageClassDynamic record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassDynamic object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class/Dynamic/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_id_Detail",
"summary": "Retrieve a UsageClassDynamic record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClassDynamic"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassDynamic object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class/Dynamic/Rule": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_Rule",
"summary": "List UsageClassDynamicRule records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageClassDynamicRule"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Dynamic/Rule/Paged": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_Rule_Paged",
"summary": "List UsageClassDynamicRule records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClassDynamicRule"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/Dynamic/Rule/{id}": {
"get": {
"operationId": "GET_Usage_Class_Dynamic_Rule_id",
"summary": "Retrieve a UsageClassDynamicRule record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClassDynamicRule"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassDynamicRule object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/ClassType": {
"get": {
"operationId": "GET_Usage_ClassType",
"summary": "List UsageClassType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageClassType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_ClassType",
"summary": "Create a UsageClassType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageClassType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClassType"
}
]
}
}
}
}
}
},
"/Usage/ClassType/Paged": {
"get": {
"operationId": "GET_Usage_ClassType_Paged",
"summary": "List UsageClassType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClassType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/ClassType/{id}": {
"get": {
"operationId": "GET_Usage_ClassType_id",
"summary": "Retrieve a UsageClassType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClassType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_ClassType_id",
"summary": "Update a UsageClassType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageClassType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageClassType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_ClassType_id",
"summary": "Delete a UsageClassType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate": {
"get": {
"operationId": "GET_Usage_Rate",
"summary": "List UsageRate records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRate"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Rate",
"summary": "Create a UsageRate record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageRate"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRate"
}
]
}
}
}
}
}
},
"/Usage/Rate/Paged": {
"get": {
"operationId": "GET_Usage_Rate_Paged",
"summary": "List UsageRate records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRate"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Rate_Paged_Detail",
"summary": "List UsageRate records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRate"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/{id}": {
"get": {
"operationId": "GET_Usage_Rate_id",
"summary": "Retrieve a UsageRate record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRate"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Rate_id",
"summary": "Update a UsageRate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageRate"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRate"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Rate_id",
"summary": "Patch a UsageRate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRate"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Rate_id",
"summary": "Delete a UsageRate record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Rate_id_Detail",
"summary": "Retrieve a UsageRate record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRate"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRate object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/CalculationType": {
"get": {
"operationId": "GET_Usage_Rate_CalculationType",
"summary": "List UsageRateCalculationType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRateCalculationType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/CalculationType/Paged": {
"get": {
"operationId": "GET_Usage_Rate_CalculationType_Paged",
"summary": "List UsageRateCalculationType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRateCalculationType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/CalculationType/{id}": {
"get": {
"operationId": "GET_Usage_Rate_CalculationType_id",
"summary": "Retrieve a UsageRateCalculationType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRateCalculationType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRateCalculationType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/Group": {
"get": {
"operationId": "GET_Usage_Rate_Group",
"summary": "List UsageRateGroup records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRateGroup"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Rate_Group",
"summary": "Create a UsageRateGroup record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageRateGroup"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRateGroup"
}
]
}
}
}
}
}
},
"/Usage/Rate/Group/Paged": {
"get": {
"operationId": "GET_Usage_Rate_Group_Paged",
"summary": "List UsageRateGroup records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRateGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Group/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Rate_Group_Paged_Detail",
"summary": "List UsageRateGroup records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRateGroup"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Group/{id}": {
"get": {
"operationId": "GET_Usage_Rate_Group_id",
"summary": "Retrieve a UsageRateGroup record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRateGroup"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRateGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Rate_Group_id",
"summary": "Update a UsageRateGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageRateGroup"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRateGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Rate_Group_id",
"summary": "Patch a UsageRateGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRateGroup"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRateGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Rate_Group_id",
"summary": "Delete a UsageRateGroup record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRateGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/Group/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Rate_Group_id_Detail",
"summary": "Retrieve a UsageRateGroup record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRateGroup"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRateGroup object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/Plan": {
"get": {
"operationId": "GET_Usage_Rate_Plan",
"summary": "List UsageRatePlan records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRatePlan"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Rate_Plan",
"summary": "Create a UsageRatePlan record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageRatePlan"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRatePlan"
}
]
}
}
}
}
}
},
"/Usage/Rate/Plan/Paged": {
"get": {
"operationId": "GET_Usage_Rate_Plan_Paged",
"summary": "List UsageRatePlan records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRatePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Plan/Paged/Detail": {
"get": {
"operationId": "GET_Usage_Rate_Plan_Paged_Detail",
"summary": "List UsageRatePlan records with pagination and detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRatePlan"
}
}
}
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rate/Plan/{id}": {
"get": {
"operationId": "GET_Usage_Rate_Plan_id",
"summary": "Retrieve a UsageRatePlan record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRatePlan"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Rate_Plan_id",
"summary": "Update a UsageRatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageRatePlan"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRatePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Usage_Rate_Plan_id",
"summary": "Patch a UsageRatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRatePlan"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Rate_Plan_id",
"summary": "Delete a UsageRatePlan record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rate/Plan/{id}/Detail": {
"get": {
"operationId": "GET_Usage_Rate_Plan_id_Detail",
"summary": "Retrieve a UsageRatePlan record with detail data.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRatePlan"
}
}
}
]
}
}
},
"description": "Detailed result including populated related data."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRatePlan object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/RaterType": {
"get": {
"operationId": "GET_Usage_RaterType",
"summary": "List UsageRaterType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRaterType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/RaterType/Paged": {
"get": {
"operationId": "GET_Usage_RaterType_Paged",
"summary": "List UsageRaterType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRaterType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/RaterType/{id}": {
"get": {
"operationId": "GET_Usage_RaterType_id",
"summary": "Retrieve a UsageRaterType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRaterType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRaterType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Rounding": {
"get": {
"operationId": "GET_Usage_Rounding",
"summary": "List UsageRounding records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRounding"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_Usage_Rounding",
"summary": "Create a UsageRounding record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageRounding"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRounding"
}
]
}
}
}
}
}
},
"/Usage/Rounding/Paged": {
"get": {
"operationId": "GET_Usage_Rounding_Paged",
"summary": "List UsageRounding records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRounding"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Rounding/{id}": {
"get": {
"operationId": "GET_Usage_Rounding_id",
"summary": "Retrieve a UsageRounding record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRounding"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRounding object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_Usage_Rounding_id",
"summary": "Update a UsageRounding record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UsageRounding"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRounding"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_Usage_Rounding_id",
"summary": "Delete a UsageRounding record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRounding object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Unit": {
"get": {
"operationId": "GET_Usage_Unit",
"summary": "List UsageUnit records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageUnit"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Unit/Paged": {
"get": {
"operationId": "GET_Usage_Unit_Paged",
"summary": "List UsageUnit records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageUnit"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Unit/{id}": {
"get": {
"operationId": "GET_Usage_Unit_id",
"summary": "Retrieve a UsageUnit record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageUnit"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageUnit object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Usage/Class/ResolverType": {
"get": {
"operationId": "GET_Usage_Class_ResolverType",
"summary": "List UsageClassResolverType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageClassResolverType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/ResolverType/Paged": {
"get": {
"operationId": "GET_Usage_Class_ResolverType_Paged",
"summary": "List UsageClassResolverType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageClassResolverType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/Usage/Class/ResolverType/{id}": {
"get": {
"operationId": "GET_Usage_Class_ResolverType_id",
"summary": "Retrieve a UsageClassResolverType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageClassResolverType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageClassResolverType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/UsageIdentifier/ByIdentifier": {
"get": {
"operationId": "GET_UsageIdentifier_ByIdentifier",
"summary": "List UsageIdentifier records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageIdentifier"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/UsageRatedExceptionSchedule/Reprocess": {
"post": {
"operationId": "POST_UsageRatedExceptionSchedule_Reprocess",
"summary": "Create a UsageRatedExceptionSchedule record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UsageRatedExceptionSchedule"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UsageRatedExceptionSchedule"
}
]
}
}
}
}
}
},
"/UsageRatedExceptionType": {
"get": {
"operationId": "GET_UsageRatedExceptionType",
"summary": "List UsageRatedExceptionType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UsageRatedExceptionType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/UsageRatedExceptionType/Paged": {
"get": {
"operationId": "GET_UsageRatedExceptionType_Paged",
"summary": "List UsageRatedExceptionType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UsageRatedExceptionType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/UsageRatedExceptionType/{id}": {
"get": {
"operationId": "GET_UsageRatedExceptionType_id",
"summary": "Retrieve a UsageRatedExceptionType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UsageRatedExceptionType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UsageRatedExceptionType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Administration/User/{id}": {
"get": {
"operationId": "GET_Administration_User_id",
"summary": "Retrieve a AdministrationUser record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AdministrationUser"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AdministrationUser object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"patch": {
"operationId": "PATCH_Administration_User_id",
"summary": "Patch a AdministrationUser record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AdministrationUser"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the AdministrationUser object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Administration/User": {
"post": {
"operationId": "POST_Administration_User",
"summary": "Create a AdministrationUser record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a AdministrationUser"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/AdministrationUser"
}
]
}
}
}
}
}
},
"/User/{userName}/LoginHistory": {
"get": {
"operationId": "GET_User_userName_LoginHistory",
"summary": "Returns the login history based on the user name",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserUserNameLoginHistoryResult"
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "userName",
"required": true,
"description": "",
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"/User/{userId}/LoginHistory": {
"get": {
"operationId": "GET_User_userId_LoginHistory",
"summary": "Returns the login history based on the user id.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserUserIdLoginHistoryResult"
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "userId",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/User/StatusType": {
"get": {
"operationId": "GET_User_StatusType",
"summary": "List UserStatusType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserStatusType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
},
"post": {
"operationId": "POST_User_StatusType",
"summary": "Create a UserStatusType record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a UserStatusType"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UserStatusType"
}
]
}
}
}
}
}
},
"/User/StatusType/Paged": {
"get": {
"operationId": "GET_User_StatusType_Paged",
"summary": "List UserStatusType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/UserStatusType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/User/StatusType/{id}": {
"get": {
"operationId": "GET_User_StatusType_id",
"summary": "Retrieve a UserStatusType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/UserStatusType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UserStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"put": {
"operationId": "PUT_User_StatusType_id",
"summary": "Update a UserStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Update a UserStatusType"
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UserStatusType"
}
]
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
},
"delete": {
"operationId": "DELETE_User_StatusType_id",
"summary": "Delete a UserStatusType record.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": " Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the UserStatusType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Account/Service/Usage/Bucket/Consumption/Paged": {
"get": {
"operationId": "GET_Account_Service_Usage_Bucket_Consumption_Paged",
"summary": "Retrieve consumption details for an account's bucket for a particular service.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountServiceUsageBucketConsumption"
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"description": "Retreive all the consumption details for a bucket attached to an account's service by providing different parameters. An example of calling this API would be Account/Service/Usage/Bucket/Paged?UdrUsageIdentifier=CCCC"
}
},
"/DataImportHistory/Exception/Paged": {
"get": {
"operationId": "GET_DataImportHistory_Exception_Paged",
"summary": "Retrieve all the data import exceptions in a paged fashion.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataImportHistoryExceptionPagedResult"
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/DataImportHistory/{id}/Exception": {
"get": {
"operationId": "GET_DataImportHistory_id_Exception",
"summary": "Retrieve data import exception based on its id.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataImportHistoryIDExceptionResult"
}
}
},
"description": "List of related records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/DataImportHistory/{id}/Exception/Paged": {
"get": {
"operationId": "GET_DataImportHistory_id_Exception_Paged",
"summary": "Retrieve data import exception based on its id.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataImportHistoryIDExceptionPagedResult"
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the DataImportHistory object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
},
"/Webhook/Callback/Adyen": {
"post": {
"operationId": "POST_Webhook_Callback_Adyen",
"summary": "Create a WebhookCallback record.",
"responses": {
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResultBase"
}
}
},
"description": "Create a new instance of a WebhookCallback"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookCallback"
}
]
}
}
}
}
}
},
"/WebhookFormatType": {
"get": {
"operationId": "GET_WebhookFormatType",
"summary": "List WebhookFormatType records.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookFormatType"
}
}
}
}
]
}
}
},
"description": "List of records."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/WebhookFormatType/Paged": {
"get": {
"operationId": "GET_WebhookFormatType_Paged",
"summary": "List WebhookFormatType records with pagination.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"type": "object",
"properties": {
"pagedResults": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the payload of the response",
"items": {
"$ref": "#/components/schemas/WebhookFormatType"
}
}
}
}
}
}
]
}
}
},
"description": "Paged list of results."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
}
}
},
"/WebhookFormatType/{id}": {
"get": {
"operationId": "GET_WebhookFormatType_id",
"summary": "Retrieve a WebhookFormatType record by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/WebhookFormatType"
}
}
}
]
}
}
},
"description": "Requested record."
},
"400": {
"description": "The request could not be processed.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
]
}
}
}
}
},
"parameters": [
{
"name": "id",
"required": true,
"description": "Unique identifier for the WebhookFormatType object.",
"schema": {
"type": "integer",
"example": 1
},
"in": "path"
}
]
}
}
},
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Use a JWT bearer token obtained from the authentication endpoint."
}
},
"schemas": {
"SingleResultBase": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"description": "Correlation ID for tracing the request"
},
"instance": {
"description": "Payload instance for single-item response"
}
},
"required": [
"trackingId",
"instance"
]
},
"MultipleResultBase": {
"description": "Base envelope for list responses.",
"type": "object",
"properties": {
"items": {
"description": "Collection of resources returned by the request."
},
"trackingId": {
"description": "Correlation ID that can be used to trace the request through the platform.",
"type": "string",
"format": "uuid"
},
"totalCount": {
"description": "Total number of matching items returned in the response.",
"type": "integer"
}
},
"required": [
"trackingId",
"items"
]
},
"PagedResultBase": {
"description": "Base envelope for paged list responses.",
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/PaginationHeader"
},
"trackingId": {
"description": "Correlation ID that can be used to trace the request through the platform.",
"type": "string",
"format": "uuid"
},
"pagedResults": {
"description": "Paged result set.",
"type": "object",
"properties": {
"items": {
"description": "Collection of resources returned for the requested page."
},
"totalCount": {
"description": "Total number of matching items when total counts are included in the response.",
"type": "integer"
}
}
}
},
"required": [
"trackingId",
"pagination",
"pagedResults"
]
},
"ActionResultBase": {
"description": "Base envelope returned by successful create, update, delete, and other action-style operations.",
"type": "object",
"properties": {
"results": {
"description": "Summary of the resources affected by the action.",
"type": "object",
"properties": {
"items": {
"description": "Resources affected by the action.",
"items": {
"$ref": "#/components/schemas/ActionResultItem"
},
"type": "array"
},
"totalCount": {
"example": 1,
"description": "Total number of result entries returned for the action.",
"type": "integer"
}
},
"required": [
"items"
],
"additionalProperties": false
},
"trackingId": {
"description": "Correlation ID that can be used to trace the request through the platform.",
"type": "string",
"format": "uuid"
},
"type": {
"example": "update",
"description": "Type of action performed by the request.",
"type": "string",
"enum": [
"create",
"read",
"update",
"delete",
"patch",
"validate",
"eventBinding",
"bulkInsert",
"sendMessage"
]
}
},
"required": [
"trackingId",
"type",
"results"
],
"additionalProperties": false
},
"Error": {
"type": "object",
"additionalProperties": true,
"properties": {
"code": {
"type": [
"integer",
"string",
"null"
],
"example": 404
},
"message": {
"type": [
"string",
"null"
],
"example": "A 'UsageRateGroup' with Id 123 was not found"
}
}
},
"ErrorMessage": {
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Error code related to this message"
},
"message": {
"type": "string",
"description": "Error message associated to this code"
}
}
},
"Account": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Account",
"readOnly": true,
"type": "number",
"example": 8
},
"currencyId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated Currency object."
},
"currencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyId property."
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 2,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "My Account",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"accountStatusTypeId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated AccountStatusType object."
},
"accountStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountStatusTypeId property."
},
"billGroupId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated BillGroup object."
},
"billGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billGroupId property."
},
"actingOwnerId": {
"readOnly": true,
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Owner object."
},
"actingOwnerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the actingOwnerId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"effectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is the date for when the account is to be cancelled. Date and time values are specified in the ISO 8601 format."
},
"invoiceDeliveryId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated InvoiceDelivery object."
},
"invoiceDeliveryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDeliveryId property."
},
"accountsReceivableTermsId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated AccountsReceivableTerms object."
},
"accountsReceivableTermsName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountsReceivableTermsId property."
},
"accountTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated AccountType object."
},
"accountTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountTypeId property."
},
"billDay": {
"type": "number",
"example": 1
},
"accountTaxCategoryId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated AccountTaxCategory object."
},
"accountTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountTaxCategoryId property."
},
"taxCodeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated TaxCode object."
},
"taxCodeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxCodeId property."
},
"invoicerAccountId": {
"type": "number",
"example": "My Invoicer Account",
"description": "This is the account that will receive the invoice for subscriptions and one-time charges. Unique identifier for the associated Account object."
},
"invoicerAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoicerAccountId property."
},
"usageInvoicerAccountId": {
"type": "number",
"example": "My Usage Invoicer Account",
"description": "This is the account that will receive the invoice for usage charges. Unique identifier for the associated Account object."
},
"usageInvoicerAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageInvoicerAccountId property."
},
"taxSettingAccountId": {
"type": "number",
"example": "My Usage Invoicer Account",
"description": "This is the account that is used for tax calculation purposes. Unique identifier for the associated Account object."
},
"taxSettingAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxSettingAccountId property."
},
"usageBillDay": {
"type": "number",
"example": 1
},
"isReadOnlyBillDay": {
"type": "boolean",
"example": true
},
"isReadOnlyUsageBillDay": {
"type": "boolean",
"example": false
},
"displayName": {
"example": "My Account Display Name",
"type": "string"
},
"createdByUserId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"pendingBillDay": {
"type": "number",
"example": "15"
},
"pendingUsageBillDay": {
"type": "number",
"example": "15"
},
"lifeline": {
"type": "boolean",
"example": false
},
"externalAccountIdentifier": {
"example": "ExternalID-2001",
"type": "string"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"vATNumber": {
"example": "VAT499001",
"type": "string"
},
"eInvoiceEndpointId": {
"example": "01394200362",
"type": "string"
},
"eInvoiceSchemeId": {
"example": "9935",
"type": "string"
},
"zeroInclusiveTaxWhenExempt": {
"type": "boolean",
"example": false
},
"defaultPaymentGatewayId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated PaymentGateway object."
},
"defaultPaymentGatewayName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultPaymentGatewayId property."
},
"defaultAdyenMerchantAccountId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated AdyenMerchantAccount object."
},
"defaultAdyenMerchantAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultAdyenMerchantAccountId property."
},
"id": {
"type": "number",
"example": 17
}
},
"description": "The Account object represents a customer account in the system. It holds essential information about the details of the account such as when it is billed."
},
"Patch": {
"type": "object",
"properties": {},
"required": []
},
"TaxAddress": {
"type": "object",
"properties": {},
"required": []
},
"Balance": {
"type": "object",
"properties": {},
"required": []
},
"AccountContract": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContract",
"readOnly": true,
"type": "number",
"example": 19
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "My Contract",
"type": "string"
},
"accountId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"accountContractStatusTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated AccountContractStatusType object."
},
"accountContractStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountContractStatusTypeId property."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date for the term of the Contract. Date and time values are specified in the ISO 8601 format."
},
"frequency": {
"type": "number",
"example": 2
},
"frequencyTypeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated FrequencyType object."
},
"frequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the frequencyTypeId property."
},
"accountContractRenewalTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated AccountContractRenewalType object."
},
"accountContractRenewalTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountContractRenewalTypeId property."
},
"renewalAccountContractId": {
"type": "number",
"example": 24,
"description": "If the contract's renew type is a new contract, then this identifier will specify the contract that that will be used on renewal. Unique identifier for the associated AccountContract object."
},
"renewalAccountContractName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the renewalAccountContractId property."
},
"contractTerminationId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated ContractTermination object."
},
"contractTerminationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractTerminationId property."
},
"terminationAccountContractStatusTypeId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated AccountContractStatusType object."
},
"terminationAccountContractStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the terminationAccountContractStatusTypeId property."
},
"renewalAccountContractStatusTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated AccountContractStatusType object."
},
"renewalAccountContractStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the renewalAccountContractStatusTypeId property."
},
"earlyTermination": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "If the contract has been terminated early, this date will specify the date of termination. Date and time values are specified in the ISO 8601 format."
},
"earlyTerminationComment": {
"example": "Hello World",
"type": "string"
},
"termTypeId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated TermType object."
},
"termTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the termTypeId property."
},
"extendedStart": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "If new packages are added to the account with package contract commitment terms that end past the current account contract term, this date will be extended to match that of the added package. Date and time values are specified in the ISO 8601 format."
},
"version": {
"type": "number",
"example": 17
},
"isSynchronousBilling": {
"type": "boolean",
"example": "true"
},
"billingFrequency": {
"type": "number",
"example": 11
},
"billingFrequencyTypeId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated FrequencyType object."
},
"billingFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billingFrequencyTypeId property."
}
},
"description": "An Account Contract object contains contract details that have been assigned to an account. There is a one-to-many relationship from an Account to multiple Account Contracts."
},
"EarlyTermination": {
"type": "object",
"properties": {},
"required": []
},
"AccountContractRenewalType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContractRenewalType",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"readOnly": true,
"example": "Expires at End of Term",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 5
}
},
"description": "This object lists the different types of contract renewals such as \"Expires at End of Term\", \"New Contract\" and \"Auto Renew\"."
},
"AccountContractStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContractStatusType",
"readOnly": true,
"type": "number",
"example": 16
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Expires at End of Term",
"type": "string"
},
"statusTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated StatusType object."
},
"statusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the statusTypeId property."
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 21
}
},
"description": "This object lists the different types of contract status types such as \"Active\" or \"Expired\"."
},
"AccountContractTrackingCommitment": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContractTrackingCommitment",
"readOnly": true,
"type": "number",
"example": 23
},
"contractCommitmentId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated ContractCommitment object."
},
"contractCommitmentName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentId property."
},
"contractCommitmentPeriodId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated ContractCommitmentPeriod object."
},
"contractCommitmentPeriodName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentPeriodId property."
},
"processed": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this contract commitment was processed. Date and time values are specified in the ISO 8601 format."
},
"invoiceItemId": {
"type": "number",
"example": 26,
"description": "If a penalty charge was generated from this contract commitment, this identifier references the invoice item representing that charge. Unique identifier for the associated InvoiceItem object."
},
"invoiceItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceItemId property."
},
"void": {
"type": "boolean",
"example": "true"
},
"invoiceId": {
"type": "number",
"example": 2,
"description": "If a penalty charge was generated from this contract commitment, this identifier references the invoice representing that charge. Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
}
},
"description": "This object contains any of the penalties generated by contract commitments that have not been met."
},
"AccountContractTrackingCommitmentInvoice": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContractTrackingCommitmentInvoice",
"readOnly": true,
"type": "number",
"example": 8
},
"contractCommitmentId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated ContractCommitment object."
},
"contractCommitmentName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentId property."
},
"invoiceId": {
"type": "number",
"example": 13,
"description": "If a penalty charge was generated from this contract commitment, this identifier references the invoice representing that charge. Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"lastProcessed": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this contract commitment was last calculated. Date and time values are specified in the ISO 8601 format."
},
"contractCommitmentPeriodId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated ContractCommitmentPeriod object."
},
"contractCommitmentPeriodName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentPeriodId property."
}
},
"description": "This object contains any of the invoices which have contract commitment charges and their associated periods."
},
"AccountContractTrackingTermination": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountContractTrackingTermination",
"readOnly": true,
"type": "number",
"example": 13
},
"contractTerminationId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated ContractTermination object."
},
"contractTerminationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractTerminationId property."
},
"invoiceItemId": {
"type": "number",
"example": 23,
"description": "If a penalty charge was generated from this contract termination, this identifier references the invoice item representing that charge. Unique identifier for the associated InvoiceItem object."
},
"invoiceItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceItemId property."
},
"processed": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this contract termination was processed. Date and time values are specified in the ISO 8601 format."
}
},
"description": "This object contains any of the penalties generated by contract early termination."
},
"ViewAccountPackage": {
"type": "object",
"properties": {
"id": {
"example": "Hello World",
"type": "string"
},
"accountId": {
"type": "number",
"example": 24
},
"accountName": {
"example": "Hello World",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"nextBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"name": {
"example": "Hello World",
"type": "string"
},
"lastStatusChanged": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"effectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"inheritedEffectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"packageFrequencyId": {
"type": "number",
"example": 15
},
"packageFrequencyName": {
"example": "Hello World",
"type": "string"
},
"termId": {
"type": "number",
"example": 15
},
"termName": {
"example": "Hello World",
"type": "string"
},
"createdByUserId": {
"type": "number",
"example": 17
},
"createdByUserName": {
"example": "Hello World",
"type": "string"
},
"billDay": {
"type": "number",
"example": 5
},
"inheritedBillDay": {
"type": "number",
"example": 4
},
"updatedByUserId": {
"type": "number",
"example": 15
},
"updatedByUserName": {
"example": "Hello World",
"type": "string"
},
"usageBillDay": {
"type": "number",
"example": 6
},
"inheritedUsageBillDay": {
"type": "number",
"example": 14
},
"activation": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"finalBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"lastBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"accountSharePlanId": {
"type": "number",
"example": 16
},
"lastUsageBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"accountProductCodeId": {
"type": "number",
"example": 3
},
"quantity": {
"type": "number",
"example": 12
},
"accountProductCodeName": {
"example": "Hello World",
"type": "string"
},
"packageCategoryId": {
"type": "number",
"example": 4
},
"packageCategoryName": {
"example": "Hello World",
"type": "string"
},
"accountEffectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"accountInvoicerAccountId": {
"type": "number",
"example": 22
},
"accountInvoicerName": {
"example": "Hello World",
"type": "string"
},
"accountUsageInvoicerAccountId": {
"type": "number",
"example": 0
},
"accountUsageInvoicerName": {
"example": "Hello World",
"type": "string"
},
"accountTaxSettingAccountId": {
"type": "number",
"example": 10
},
"accountTaxSettingName": {
"example": "Hello World",
"type": "string"
},
"packageId": {
"type": "number",
"example": 15
},
"packageName": {
"example": "Hello World",
"type": "string"
},
"packageFrequencyFrequency": {
"type": "number",
"example": 15
},
"packageFrequencyIsActive": {
"type": "boolean",
"example": "true"
},
"frequencyTypeId": {
"type": "number",
"example": 11
},
"frequencyTypeName": {
"example": "Hello World",
"type": "string"
},
"billGroupId": {
"type": "number",
"example": 18
},
"billGroupName": {
"example": "Hello World",
"type": "string"
},
"postPaid": {
"type": "boolean",
"example": "true"
},
"billingActivationTypeId": {
"type": "number",
"example": 19
},
"fullPeriod": {
"type": "boolean",
"example": "true"
},
"priceBookId": {
"type": "number",
"example": 12
}
}
},
"AccountPackage": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountPackage",
"readOnly": true,
"type": "string",
"example": "Hello World"
},
"accountId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"nextBill": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this account will be billed next. Date and time values are specified in the ISO 8601 format."
},
"name": {
"example": "Hello World",
"type": "string"
},
"lastStatusChanged": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date on when this Account Package is to have its charge calculated. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"effectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this Account Package should be cancelled. Date and time values are specified in the ISO 8601 format."
},
"packageFrequencyId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated PackageFrequency object."
},
"packageFrequencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageFrequencyId property."
},
"createdByUserId": {
"readOnly": true,
"type": "number",
"example": 21,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"billDay": {
"type": "number",
"example": 7
},
"updatedByUserId": {
"readOnly": true,
"type": "number",
"example": 25,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"usageBillDay": {
"type": "number",
"example": 7
},
"activation": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"finalBill": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this Account Package had it's final bill generated. Applies to Account Packages that have been cancelled. Date and time values are specified in the ISO 8601 format."
},
"lastBilled": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this Account Package was last billed. Date and time values are specified in the ISO 8601 format."
},
"accountSharePlanId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated AccountSharePlan object."
},
"accountSharePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountSharePlanId property."
},
"lastUsageBilled": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this Account Package's usage was last billed. Date and time values are specified in the ISO 8601 format."
},
"accountProductCodeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated AccountProductCode object."
},
"accountProductCodeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountProductCodeId property."
},
"packageCategoryId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated PackageCategory object."
},
"packageCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageCategoryId property."
},
"chargeRecurringIfUsage": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"updatedByPortalUserId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "If this Account Package has been updated by the end customer in the LogiSense customer portal, then this ID represents that User. Unique identifier for the associated PortalUser object."
},
"updatedByPortalUserName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByPortalUserId property."
},
"pendingBillDay": {
"type": "number",
"example": "15"
},
"pendingUsageBillDay": {
"type": "number",
"example": "15"
},
"billCancelOptionTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated BillCancelOptionType object."
},
"billCancelOptionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billCancelOptionTypeId property."
},
"waiveEarlyTerminationFee": {
"type": "boolean",
"example": false
},
"billingActivationTypeId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated BillingActivationType object."
},
"billingActivationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billingActivationTypeId property."
},
"quantity": {
"type": "number",
"example": "1"
},
"isQuantityAllowed": {
"type": "boolean",
"example": false
},
"importLastBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date the account package was imported. Date and time values are specified in the ISO 8601 format."
},
"priceBookId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
},
"accountContractId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated AccountContract object."
},
"accountContractName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountContractId property."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"taxAddressId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated TaxAddress object."
},
"taxAddressName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxAddressId property."
},
"accountPackageStatusTypeId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated AccountPackageStatusType object."
},
"accountPackageStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountPackageStatusTypeId property."
},
"id": {
"example": "Hello World",
"type": "string"
}
},
"description": "This object contains all the information associated with a Package that has been assigned to an Account."
},
"CancelSetting": {
"type": "object",
"properties": {},
"required": []
},
"HasBucketedUsage": {
"type": "object",
"properties": {},
"required": []
},
"AccountPackageStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountPackageStatusType",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 25,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"preventChanges": {
"type": "boolean",
"example": "true"
},
"baseBillingStatusTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated BaseBillingStatusType object."
},
"baseBillingStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the baseBillingStatusTypeId property."
}
},
"description": "This object represents user definable statuses for account packages that are based on a main base type that has meaning."
},
"AccountParent": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountParent",
"readOnly": true,
"type": "number",
"example": 24
},
"accountId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"parentAccountId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated Account object."
},
"parentAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the parentAccountId property."
},
"topAccountId": {
"readOnly": true,
"type": "number",
"example": 0,
"description": "Unique identifier for the associated Account object."
},
"topAccountName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the topAccountId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {}
},
"description": "This object represents the hierarchy connections between different accounts within the system."
},
"AccountPricePlan": {
"type": "object",
"properties": {
"identity": {
"description": "Unique identifier for the account price plan.",
"readOnly": true,
"type": "integer",
"example": 14
},
"name": {
"example": "Hello World",
"type": "string"
},
"accountId": {
"type": "integer",
"example": 25,
"description": "Unique identifier for the associated account."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"description": {
"example": "Hello World",
"type": "string"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Price Plan effective start date. Date and time values are specified in the ISO 8601 format."
},
"end": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Price Plan effective end date. Date and time values are specified in the ISO 8601 format."
},
"lastUsedForBilling": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "When this price plan was last used for calculating pricing for an invoice. Date and time values are specified in the ISO 8601 format."
},
"includeChildAccounts": {
"type": "boolean",
"example": "true"
}
},
"description": "Top-level account price plan that holds package pricing configuration for a specific account."
},
"AccountProductCode": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountProductCode",
"readOnly": true,
"type": "number",
"example": 19
},
"name": {
"example": "Hello World",
"type": "string"
},
"accountId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
}
},
"description": "A unique identifier for particular product that has custom pricing attached to it. Allowing you to have 2 of the same products but with different custom pricing on each based on their product code. These are used in Account Price Plans and on Sales Orders.Essentially you can create a customer specific product code with pricing for a Package added to their Price Plan. This creates a customer specific product catalog that can then be added to the account like a standard Package."
},
"AccountService": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountService",
"readOnly": true,
"type": "string",
"example": "Hello World"
},
"serviceId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Service object."
},
"serviceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceId property."
},
"accountId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"accountPackageId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountPackage object."
},
"accountPackageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountPackageId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"amount": {
"type": "number",
"example": 15
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The effective date when this account service becomes billable. Date and time values are specified in the ISO 8601 format."
},
"posted": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updatedByUserId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"effectiveCancel": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service will be cancelled. Date and time values are specified in the ISO 8601 format."
},
"usageNextBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service will have its related usage billed. Date and time values are specified in the ISO 8601 format."
},
"usageFinalBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service had its final related usage billed. Date and time values are specified in the ISO 8601 format."
},
"finalBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service had its final related recurring and one time charges billed. Date and time values are specified in the ISO 8601 format."
},
"lastBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service's related recurring and one time charges were last billed. Date and time values are specified in the ISO 8601 format."
},
"lastUsageBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date when this account service's related usage was last billed. Date and time values are specified in the ISO 8601 format."
},
"addOnPackageFrequencyId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated PackageFrequency object."
},
"addOnPackageFrequencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the addOnPackageFrequencyId property."
},
"billCancelOptionTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated BillCancelOptionType object."
},
"billCancelOptionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billCancelOptionTypeId property."
},
"isTaxInclusive": {
"type": "boolean",
"example": "true"
},
"serviceTaxCategoryId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"importLastUsageBilled": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date the account service was imported on. Date and time values are specified in the ISO 8601 format."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"id": {
"example": "Hello World",
"type": "string"
}
},
"description": "An Account Service is a billable line item of a Package that has been assigned to an account."
},
"Current": {
"type": "object",
"properties": {},
"required": []
},
"AccountServiceUsageBucket": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountServiceUsageBucket",
"readOnly": true,
"type": "number",
"example": 27
},
"usageBucketId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageBucket object."
},
"usageBucketName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketId property."
},
"accountServiceId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountService object."
},
"accountServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceId property."
},
"refillFrequency": {
"readOnly": true,
"type": "number",
"example": 25
},
"refillFrequencyTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated FrequencyType object."
},
"refillFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the refillFrequencyTypeId property."
},
"effective": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this bucket becomes enabled. This is inherited from the Account Service. Date and time values are specified in the ISO 8601 format."
},
"effectiveCancel": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date in which this bucket should be cancelled. This is inherited from the Account Service. Date and time values are specified in the ISO 8601 format."
},
"prorate": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isInfiniteLastTier": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isThresholdPerAccountService": {
"type": "boolean",
"example": "true"
},
"usageBucketRefillTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated UsageBucketRefillType object."
},
"usageBucketRefillTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketRefillTypeId property."
},
"expireAfterFrequency": {
"readOnly": true,
"type": "number",
"example": 21
},
"expireAfterFrequencyTypeId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated FrequencyType object."
},
"expireAfterFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the expireAfterFrequencyTypeId property."
},
"expireAfterRecurrence": {
"readOnly": true,
"type": "number",
"example": 16
},
"accountPackageActivation": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isSharedAcrossPackage": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"overageUsageRatePlanId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated UsageRatePlan object."
},
"overageUsageRatePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the overageUsageRatePlanId property."
}
},
"description": "A Usage Bucket associated with an Account Service. This typically will hold any inclusions of usage for the Account Service."
},
"AccountSharePlan": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountSharePlan",
"readOnly": true,
"type": "number",
"example": 7
},
"usageBucketSharePlanId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated UsageBucketSharePlan object."
},
"usageBucketSharePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketSharePlanId property."
},
"usageBucketShareLevelId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated UsageBucketShareLevel object."
},
"usageBucketShareLevelName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketShareLevelId property."
},
"accountId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"accountServiceId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountService object."
},
"accountServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceId property."
},
"isAvailable": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"sharePlanAccountPackageId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountPackage object."
},
"sharePlanAccountPackageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the sharePlanAccountPackageId property."
},
"sellingAccountPackageId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountPackage object."
},
"sellingAccountPackageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the sellingAccountPackageId property."
},
"bucketPriorityTieBreaker": {
"type": "number",
"example": 8
}
},
"description": "A Share Plan assigned to an Account. A Share Plan is a way of pooling usage across multiple Services and Packages. This entity is essentially a linking object between a defined Share Plan and an Account."
},
"Rank": {
"type": "object",
"properties": {},
"required": []
},
"AddOn": {
"type": "object",
"properties": {},
"required": []
},
"ProductCode": {
"type": "object",
"properties": {},
"required": []
},
"AttachedProductCode": {
"type": "object",
"properties": {},
"required": []
},
"ViewSharePlanBucketUsageByService": {
"type": "object",
"properties": {
"accountSharePlanId": {
"type": "number",
"example": 21
},
"accountServiceUsageBucketId": {
"readOnly": true,
"type": "number",
"example": 0
},
"accountServiceUsageBucketTotalUsageAmount": {
"readOnly": true,
"type": "number",
"example": 23
},
"accountServiceUsageBucketTotalUsageConsumed": {
"readOnly": true,
"type": "number",
"example": 2
},
"accountServiceUsageBucketIsAddOn": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"packageId": {
"readOnly": true,
"type": "number",
"example": 22
},
"packageName": {
"readOnly": true,
"example": "Hello World",
"type": "string"
},
"serviceId": {
"readOnly": true,
"type": "number",
"example": 11
},
"serviceName": {
"readOnly": true,
"example": "Hello World",
"type": "string"
},
"quantity": {
"readOnly": true,
"type": "number",
"example": 6
},
"usageConsumed": {
"readOnly": true,
"example": "Hello World",
"type": "string"
},
"accountServiceUsageBucketRecurFrequency": {
"type": "number",
"example": 23
},
"accountServiceUsageBucketRecurFrequencyTypeId": {
"type": "number",
"example": 6
},
"accountServiceUsageBucketRecurFrequencyTypeName": {
"example": "Hello World",
"type": "string"
},
"accountServiceUsageBucketIsThresholdPerAccountService": {
"type": "boolean",
"example": "true"
},
"accountServiceUsageBucketIsInfiniteLastTier": {
"type": "boolean",
"example": "true"
},
"usageBucketId": {
"type": "number",
"example": 18
},
"usageBucketName": {
"readOnly": true,
"example": "Hello World",
"type": "string"
},
"usageBucketBaseUnitId": {
"readOnly": true,
"type": "number",
"example": 13
}
},
"description": "This object provides a view into which services are actively participating in a Share Plan assigned to an Account."
},
"AccountSharePlanContribution": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountSharePlanContribution",
"readOnly": true,
"type": "number",
"example": 15
},
"accountSharePlanParticipationId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated AccountSharePlanParticipation object."
},
"accountSharePlanParticipationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountSharePlanParticipationId property."
},
"accountServiceUsageBucketId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated AccountServiceUsageBucket object."
},
"accountServiceUsageBucketName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceUsageBucketId property."
},
"isContributing": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"contributingAmount": {
"readOnly": true,
"type": "number",
"example": 23
},
"contributingUsageUnitId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated UsageUnit object."
},
"contributingUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contributingUsageUnitId property."
}
},
"description": "A listing of contribution details of services to a specified Share Plan on an account."
},
"AccountSharePlanParticipation": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountSharePlanParticipation",
"readOnly": true,
"type": "number",
"example": 4
},
"accountSharePlanId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated AccountSharePlan object."
},
"accountSharePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountSharePlanId property."
},
"serviceId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated Service object."
},
"serviceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceId property."
},
"packageId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated Package object."
},
"packageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageId property."
},
"dataParticipatingLimit": {
"type": "number",
"example": 11
},
"dataUsageUnitId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated UsageUnit object."
},
"dataUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataUsageUnitId property."
},
"timeParticipatingLimit": {
"type": "number",
"example": 19
},
"timeUsageUnitId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageUnit object."
},
"timeUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the timeUsageUnitId property."
},
"countParticipatingLimit": {
"type": "number",
"example": 19
},
"countUsageUnitId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated UsageUnit object."
},
"countUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the countUsageUnitId property."
},
"moneyParticipatingLimit": {
"type": "number",
"example": 26
},
"moneyUsageUnitId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated UsageUnit object."
},
"moneyUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the moneyUsageUnitId property."
},
"accountProductCodeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated AccountProductCode object."
},
"accountProductCodeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountProductCodeId property."
}
},
"description": "A listing of Services that are participating in a specified Share Plan for an Account."
},
"AccountStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountStatusType",
"readOnly": true,
"type": "number",
"example": 7
},
"name": {
"example": "Hello World",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 2,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"isDefault": {
"type": "boolean",
"example": "true"
},
"preventChanges": {
"type": "boolean",
"example": "true"
},
"baseBillingStatusTypeId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated BaseBillingStatusType object."
},
"baseBillingStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the baseBillingStatusTypeId property."
}
},
"description": "The user defined statuses that can be configured and assigned to an Account. Their meaning is then tied to a base status type to determine if it is billable, non-billable or cancelled."
},
"AccountTaxCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountTaxCategory",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"example": "Default Tax Category",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 25,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
}
},
"description": "An Account Tax Category is assigned to a group of Accounts that are to be taxed in the same manner."
},
"AccountForget": {
"type": "object",
"properties": {}
},
"AccountInvoiceDiscountTracking": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountInvoiceDiscountTracking",
"readOnly": true,
"type": "number",
"example": 4
},
"accountInvoiceDiscountId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated AccountInvoiceDiscount object."
},
"accountInvoiceDiscountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountInvoiceDiscountId property."
},
"invoiceId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"invoiceItemId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated InvoiceItem object."
},
"invoiceItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceItemId property."
},
"amount": {
"type": "number",
"example": 22
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
}
},
"AccountTaxExemptLevel": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountTaxExemptLevel",
"readOnly": true,
"type": "number",
"example": 19
},
"accountId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"taxExemptLevelId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated TaxExemptLevel object."
},
"taxExemptLevelName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxExemptLevelId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {}
},
"description": "This entity is used specifically to assign a tax level from a tax software integration such as Avalara to the account. This defines different levels in which taxes would need to be applied such as \"state\", \"federal\"."
},
"AccountType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountType",
"readOnly": true,
"type": "number",
"example": 18
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Customer",
"type": "string"
},
"isDefault": {
"type": "boolean",
"example": "true"
}
},
"description": "An Account Type is a user defined list of possible account types you wish to specify in the system. Examples are \"Partner\", \"Customer\", \"Reseller\" etc."
},
"AccountsReceivableTerms": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AccountsReceivableTerms",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 16,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Net 30",
"type": "string"
},
"paymentTermId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated PaymentTerm object."
},
"paymentTermName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTermId property."
},
"paymentDunningRuleId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated PaymentDunningRule object."
},
"paymentDunningRuleName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentDunningRuleId property."
},
"isDefault": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity is assigned to an Account to determine which payment terms and dunning rules should apply."
},
"AdyenMerchantAccount": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AdyenMerchantAccount",
"readOnly": true,
"type": "number",
"example": 23
},
"name": {
"example": "Hello World",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"paymentGatewayId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated PaymentGateway object."
},
"paymentGatewayName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentGatewayId property."
}
}
},
"ApplicationVersion": {
"type": "object",
"properties": {},
"description": "This entity is route allows you to query the system to find out its current version."
},
"AuthenticationType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the AuthenticationType",
"readOnly": true,
"type": "number",
"example": 23
},
"name": {
"example": "Hello World",
"type": "string"
}
},
"description": "A listing of authentication types used within the system."
},
"BillCancelOptionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillCancelOptionType",
"readOnly": true,
"type": "number",
"example": 17
},
"name": {
"example": "Prorate Final Period Charge",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 15
}
},
"description": "This entity allows you to query the system to find out the different final bill charging options."
},
"BillGroup": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillGroup",
"readOnly": true,
"type": "number",
"example": 18
},
"name": {
"example": "First of the Month",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"billDay": {
"type": "number",
"example": 22
},
"invoiceDateProcessTypeId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated InvoiceDateProcessType object."
},
"invoiceDateProcessTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDateProcessTypeId property."
},
"invoiceDueDateTypeId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated InvoiceDueDateType object."
},
"invoiceDueDateTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDueDateTypeId property."
},
"usageBillDay": {
"type": "number",
"example": 6
},
"invoiceDeliveryId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated InvoiceDelivery object."
},
"invoiceDeliveryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDeliveryId property."
}
},
"description": "A Bill Group is assigned to an Account to group Accounts together that follow the same billing rules. These details contain configuration such as bill day, invoice delivery method etc."
},
"BillGroupAccountExclude": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillGroupAccountExclude",
"readOnly": true,
"type": "number",
"example": 10
},
"billGroupId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated BillGroup object."
},
"billGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billGroupId property."
},
"accountId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
}
},
"description": "This is a linking entity that specifies which Accounts should not be included in this Bill Group. This is used in scenarios where an account needs to be removed from a Bill Group temporarily to run invoicing."
},
"BillRun": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRun",
"readOnly": true,
"type": "number",
"example": 9
},
"billPeriodEnd": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The end date to look for billable transactions. Date and time values are specified in the ISO 8601 format."
},
"billPeriodStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date to look for billable transactions. Date and time values are specified in the ISO 8601 format."
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 14,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"runBilling": {
"type": "boolean",
"example": "true"
},
"name": {
"example": "First of the Month Invoice Delivery",
"type": "string"
},
"runDelivery": {
"type": "boolean",
"example": "true"
},
"runRenderInvoice": {
"type": "boolean",
"example": "true"
},
"runPaymentTerm": {
"type": "boolean",
"example": "true"
},
"runBillUsage": {
"type": "boolean",
"example": "true"
},
"enabled": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"runPaymentRetryTerms": {
"type": "boolean",
"example": "true"
},
"collectionTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated CollectionType object."
},
"collectionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the collectionTypeId property."
},
"runInvoicing": {
"type": "boolean",
"example": "true"
},
"currencyExchangeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated CurrencyExchange object."
},
"currencyExchangeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyExchangeId property."
},
"runContract": {
"type": "boolean",
"example": "true"
},
"posting": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Specify the accounting posting date associated with this Bill Run. Date and time values are specified in the ISO 8601 format."
},
"billRunStatusTypeId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated BillRunStatusType object."
},
"billRunStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunStatusTypeId property."
},
"runPayment": {
"type": "boolean",
"example": "true"
},
"billRunTypeId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated BillRunType object."
},
"billRunTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunTypeId property."
},
"runInvoicingContract": {
"type": "boolean",
"example": "true"
}
},
"description": "A Bill Run is used to execute billing on a set of Bill Groups. There are multiple different options that can be selected on what should be included as actions of the Bill Run."
},
"BillRunHistory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunHistory",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 11,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"billRunId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated BillRun object."
},
"billRunName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"complete": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"billRunScheduleId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated BillRunSchedule object."
},
"billRunScheduleName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunScheduleId property."
},
"currencyExchangeId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated CurrencyExchange object."
},
"currencyExchangeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyExchangeId property."
},
"parentBillRunHistoryId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated BillRunHistory object."
},
"parentBillRunHistoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the parentBillRunHistoryId property."
}
},
"description": "A list of previously run, or currently running, Bill Run details."
},
"Recovery": {
"type": "object",
"properties": {},
"required": []
},
"BillRunSchedule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunSchedule",
"readOnly": true,
"type": "number",
"example": 1
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"start": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The time stamp when this Bill Run Schedule started. Date and time values are specified in the ISO 8601 format."
},
"complete": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The time stamp when this Bill Run Schedule completed. Date and time values are specified in the ISO 8601 format."
},
"billRunId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated BillRun object."
},
"billRunName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunId property."
},
"billRunScheduleStatusTypeId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated BillRunScheduleStatusType object."
},
"billRunScheduleStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunScheduleStatusTypeId property."
},
"accountId": {
"type": "number",
"example": 21,
"description": "This property would be used in a one-off Bill Run for a specific Account. Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Start date for the billing period. Date and time values are specified in the ISO 8601 format."
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "End date for the billing period. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"orderId": {
"type": "number",
"example": 11,
"description": "This property would be used in a one-off Bill Run for a specific Order. Unique identifier for the associated Order object."
},
"orderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the orderId property."
},
"parentBillRunId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated BillRun object."
},
"parentBillRunName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the parentBillRunId property."
},
"scheduleId": {
"type": "number",
"example": 25
},
"billRunSettings": {
"example": "Hello World",
"type": "string"
}
},
"description": "The Bill Run Schedule holds information for any one-off or recurring scheduled Bill Runs."
},
"Cancel": {
"type": "object",
"properties": {},
"required": []
},
"BillRunScheduleStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunScheduleStatusType",
"readOnly": true,
"type": "number",
"example": 16
},
"name": {
"readOnly": true,
"example": "Hello World",
"type": "string"
}
},
"description": "The Bill Run Schedule Status Type are internal statuses for a Bill Run Schedule."
},
"BillRunStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunStatusType",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"readOnly": true,
"example": "Completed",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 0
}
},
"description": "The Bill Run Status Type are internal statuses for a Bill Run showing their current status in the billing pipeline. Such as \"Completed\", \"Failed\" etc."
},
"BillRunStepType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunStepType",
"readOnly": true,
"type": "number",
"example": 1
},
"name": {
"readOnly": true,
"example": "Scheduled",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 26
}
},
"description": "The Bill Run Step Types are internal statuses for a Bill Run showing their current step in the billing pipeline. Such as \"Scheduled\", \"In-Progress\" etc."
},
"BillRunType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the BillRunType",
"readOnly": true,
"type": "number",
"example": 13
},
"name": {
"example": "Hello World",
"type": "string"
}
},
"description": "A list of Bill Run types available."
},
"CardType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CardType",
"readOnly": true,
"type": "number",
"example": 22
},
"name": {
"readOnly": true,
"example": "Mastercard",
"type": "string"
},
"vendorCardName": {
"readOnly": true,
"example": "MC",
"type": "string"
},
"paymentProviderId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated PaymentProvider object."
},
"paymentProviderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentProviderId property."
},
"paymentBaseTypeId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated PaymentBaseType object."
},
"paymentBaseTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentBaseTypeId property."
}
},
"description": "Card Types represent different types of payment cards. Such as \"Visa\" and \"Mastercard\" which then map up to payment gateway specific names for these cards."
},
"CollectionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CollectionType",
"readOnly": true,
"type": "number",
"example": 17
},
"name": {
"readOnly": true,
"example": "Credit Card",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 8
}
},
"description": "This entity represents different payment types. Such as \"Credit Card\", \"ACH\", \"Cheque\" etc."
},
"ConditionFieldType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ConditionFieldType",
"readOnly": true,
"type": "number",
"example": 0
},
"name": {
"example": "Hello World",
"type": "string"
},
"field": {
"example": "Hello World",
"type": "string"
},
"conditionTableTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated ConditionTableType object."
},
"conditionTableTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the conditionTableTypeId property."
},
"dataSourceColumnDataTypeId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated DataSourceColumnDataType object."
},
"dataSourceColumnDataTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataSourceColumnDataTypeId property."
}
}
},
"Contact": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Contact",
"readOnly": true,
"type": "number",
"example": 26
},
"contactTypeId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated ContactType object."
},
"contactTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contactTypeId property."
},
"title": {
"example": "Mr.",
"type": "string"
},
"firstName": {
"example": "John",
"type": "string"
},
"lastName": {
"example": "Doe",
"type": "string"
},
"isUsedForTax": {
"type": "boolean",
"example": "true"
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
}
},
"description": "This entity represents a Contact that has been assigned to an Account."
},
"ContactPointType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContactPointType",
"readOnly": true,
"type": "number",
"example": 16
},
"name": {
"readOnly": true,
"example": "email",
"type": "string"
},
"dataTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated DataType object."
},
"dataTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataTypeId property."
},
"isRequired": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"contactTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated ContactType object."
},
"contactTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contactTypeId property."
},
"allowMultiple": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isCore": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents the different ways in which a Contact can be communicated with. Examples are \"email\", \"phone\", \"text\" and \"address\"."
},
"ContactType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContactType",
"readOnly": true,
"type": "number",
"example": 23
},
"name": {
"example": "Shipping",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 7,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"isRequired": {
"type": "boolean",
"example": "true"
},
"contactTypeTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated ContactTypeType object."
},
"contactTypeTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contactTypeTypeId property."
},
"description": {
"example": "Shipping contact for the account",
"type": "string"
},
"sendEmail": {
"type": "boolean",
"example": "true"
},
"showOnOverview": {
"type": "boolean",
"example": "true"
},
"showOnNewAccount": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents a type of a Contact in the system. Examples would \"Billing\", \"Shipping\" etc."
},
"ContactTypeType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContactTypeType",
"readOnly": true,
"type": "number",
"example": 24
},
"name": {
"readOnly": true,
"example": "Billing",
"type": "string"
}
},
"description": "This entity represents types in the system that specify whether or not the Contact address should be used as the billing address, or the service address for taxation purposes."
},
"ContractCommitment": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContractCommitment",
"readOnly": true,
"type": "number",
"example": 21
},
"accountContractId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated AccountContract object."
},
"accountContractName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountContractId property."
},
"contractCommitmentTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated ContractCommitmentType object."
},
"contractCommitmentTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentTypeId property."
},
"penaltyServiceId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated Service object."
},
"penaltyServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the penaltyServiceId property."
},
"penaltyDescription": {
"example": "Minimum quantity commit.",
"type": "string"
},
"includeChildAccounts": {
"type": "boolean",
"example": "true"
},
"contractCommitmentPenaltyChargeTypeId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated ContractCommitmentPenaltyChargeType object."
},
"contractCommitmentPenaltyChargeTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contractCommitmentPenaltyChargeTypeId property."
}
},
"description": "This entity is the top level container for a Contract Commitment that is associated with an Account Contract."
},
"ContractCommitmentType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContractCommitmentType",
"readOnly": true,
"type": "number",
"example": 7
},
"name": {
"example": "Invoice Amount",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 6
}
},
"description": "This entity is the system defined type of contract commitment such as \"invoice amount\", \"package\", \"service\" and \"usage\"."
},
"ContractTermination": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContractTermination",
"readOnly": true,
"type": "number",
"example": 15
},
"penaltyServiceId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated Service object."
},
"penaltyServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the penaltyServiceId property."
},
"name": {
"example": "Early Termination Fee",
"type": "string"
}
},
"description": "This entity is the top level container for penalty charges for an Account Contract. This could contain multiple penalties for the Account Contract."
},
"ContractCommitmentPenaltyChargeType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ContractCommitmentPenaltyChargeType",
"readOnly": true,
"type": "number",
"example": 10
},
"name": {
"example": "Fixed Penalty Charge",
"type": "string"
}
},
"description": "This entity represents different types of penalty charges such as fixed penalties, per unit, per unit charge type or other categorizations of penalty charges."
},
"CountingRule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CountingRule",
"readOnly": true,
"type": "number",
"example": 26
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"statusTierTypeId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated StatusTierType object."
},
"statusTierTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the statusTierTypeId property."
},
"countingRuleTypeId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated CountingRuleType object."
},
"countingRuleTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the countingRuleTypeId property."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"countIfUsage": {
"type": "boolean",
"example": "true"
}
}
},
"Country": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Country",
"readOnly": true,
"type": "number",
"example": 12
},
"name": {
"example": "United States of America",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 1
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 5,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"countryAddressFormatId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated CountryAddressFormat object."
},
"countryAddressFormatName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the countryAddressFormatId property."
},
"countryCode": {
"example": "US",
"type": "string"
},
"isVisible": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity contains a list of country definitions."
},
"CountryAddressFormat": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CountryAddressFormat",
"readOnly": true,
"type": "number",
"example": 1
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 27,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"readOnly": true,
"example": "States and Provinces",
"type": "string"
},
"isStateRequired": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isStateVisible": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isCityRequired": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isCityVisible": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isAddress2Visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isZipCodeRequired": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isZipCodeVisible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "This internal entity contains properties regarding address formats for country definitions. Allows you to specify if a country has states/provinces or not."
},
"CreditItem": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CreditItem",
"readOnly": true,
"type": "number",
"example": 1
},
"invoiceItemId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated InvoiceItem object."
},
"invoiceItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceItemId property."
},
"showOnInvoice": {
"type": "boolean",
"example": "true"
},
"showOnCreditNote": {
"type": "boolean",
"example": "true"
},
"creditNoteId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated CreditNote object."
},
"creditNoteName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the creditNoteId property."
},
"automaticDisburse": {
"type": "boolean",
"example": "true"
},
"disbursed": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents a Credit on an Account."
},
"CreditNote": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CreditNote",
"readOnly": true,
"type": "number",
"example": 24
},
"accountId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"templateId": {
"type": "number",
"example": 12,
"description": "The Credit Note template that was used. Unique identifier for the associated Template object."
},
"templateName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the templateId property."
},
"sent": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The Date Time stamp for when this Credit Note was sent to the Account Contact. Date and time values are specified in the ISO 8601 format."
},
"name": {
"example": "Hello World",
"type": "string"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date stamp to appear on the Credit Note. Date and time values are specified in the ISO 8601 format."
},
"invoiceDeliveryTypeId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated InvoiceDeliveryType object."
},
"invoiceDeliveryTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDeliveryTypeId property."
},
"description": {
"example": "Hello World",
"type": "string"
}
},
"description": "This entity represents a Credit Note on an Account with related details."
},
"Send": {
"type": "object",
"properties": {},
"required": []
},
"Download": {
"type": "object",
"properties": {},
"required": []
},
"Currency": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Currency",
"readOnly": true,
"type": "number",
"example": 4
},
"name": {
"example": "US Dollars",
"type": "string"
},
"code": {
"example": "USD",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"symbol": {
"example": "$",
"type": "string"
},
"isDefault": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents the Currencies in which you perform business."
},
"CurrencyExchange": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CurrencyExchange",
"readOnly": true,
"type": "number",
"example": 5
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Canadian Rates",
"type": "string"
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "When do these exchange rates come into effect. Date and time values are specified in the ISO 8601 format."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
}
},
"description": "This entity represents the container that holds exchange rates for a particular Currency."
},
"CurrencyExchangeDetail": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the CurrencyExchangeDetail",
"readOnly": true,
"type": "number",
"example": 14
},
"currencyId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Currency object."
},
"currencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyId property."
},
"currencyExchangeId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated CurrencyExchange object."
},
"currencyExchangeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyExchangeId property."
},
"rate": {
"type": "number",
"example": 0
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
},
"description": "This entity represents the individual exhange rates for a particular Currency."
},
"CustomDataSource": {
"type": "object",
"properties": {},
"required": []
},
"Metadata": {
"type": "object",
"properties": {},
"required": []
},
"MetadataSql": {
"type": "object",
"properties": {},
"required": []
},
"DailyUsageRatedException": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DailyUsageRatedException",
"readOnly": true,
"type": "number",
"example": 24
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 7,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"date": {
"example": "Hello World",
"type": "string"
},
"accountId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"usageRatedExceptionTypeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageRatedExceptionType object."
},
"usageRatedExceptionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageRatedExceptionTypeId property."
},
"totalCount": {
"type": "number",
"example": 18
}
},
"description": "Details the usage rating exceptions."
},
"ViewUDRDailyAggregateUsage": {
"type": "object",
"properties": {
"accountId": {
"type": "number",
"example": 3
},
"accountName": {
"example": "Hello World",
"type": "string"
},
"accountPackageId": {
"example": "Hello World",
"type": "string"
},
"accountPackageName": {
"example": "Hello World",
"type": "string"
},
"accountServiceId": {
"example": "Hello World",
"type": "string"
},
"accountServiceName": {
"example": "Hello World",
"type": "string"
},
"accountServiceTemporalId": {
"example": "Hello World",
"type": "string"
},
"udrUsageIdentifier": {
"example": "Hello World",
"type": "string"
},
"date": {
"example": "Hello World",
"type": "string"
},
"usageTotal": {
"example": "145.78",
"type": "string"
},
"usageBaseUnitId": {
"type": "number",
"example": 16
},
"usageBaseUnitName": {
"example": "Hello World",
"type": "string"
},
"usageClassId": {
"type": "number",
"example": 20
},
"usageClassName": {
"example": "Hello World",
"type": "string"
},
"usageClassTypeId": {
"type": "number",
"example": 0
},
"usageClassTypeName": {
"example": "Hello World",
"type": "string"
}
},
"description": "Summary of usage by day."
},
"DataExport": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DataExport",
"readOnly": true,
"type": "number",
"example": 18
},
"name": {
"example": "Hello World",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"storageLocationId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated StorageLocation object."
},
"storageLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the storageLocationId property."
},
"dataExportTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated DataExportType object."
},
"dataExportTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataExportTypeId property."
},
"config": {
"example": "Hello World",
"type": "string"
}
}
},
"TriggerExport": {
"type": "object",
"properties": {},
"required": []
},
"DataExportHistory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DataExportHistory",
"readOnly": true,
"type": "number",
"example": 1
},
"dataExportId": {
"readOnly": true,
"type": "number",
"example": 17,
"description": "Unique identifier for the associated DataExport object."
},
"dataExportName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataExportId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"complete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"dataExportHistoryStatusTypeId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated DataExportHistoryStatusType object."
},
"dataExportHistoryStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataExportHistoryStatusTypeId property."
},
"storageLocationId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated StorageLocation object."
},
"storageLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the storageLocationId property."
},
"storageKey": {
"example": "123ABC",
"type": "string"
},
"exportRowCount": {
"type": "number",
"example": 13
},
"createdByUserId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"parameters": {
"example": "Hello World",
"type": "string"
},
"transferLocationId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated TransferLocation object."
},
"transferLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the transferLocationId property."
},
"fileMoveLogIdentity": {
"readOnly": true,
"type": "number",
"example": 2
}
},
"description": "A Share Plan assigned to an Account. A Share Plan is a way of pooling usage across multiple Services and Packages. This entity is essentially a linking object between a defined Share Plan and an Account."
},
"DataImport": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DataImport",
"readOnly": true,
"type": "number",
"example": 21
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"dataProfileId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated DataProfile object."
},
"dataProfileName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataProfileId property."
},
"envelopesPerRequest": {
"type": "number",
"example": 7
},
"patchesPerEnvelope": {
"type": "number",
"example": 16
},
"stopOnError": {
"type": "boolean",
"example": "true"
}
},
"description": "Retrieves the most recent DataImport upload instance."
},
"LastUpload": {
"type": "object",
"properties": {},
"required": []
},
"DataImportUsage": {
"type": "object",
"properties": {},
"description": "Import raw usage data for the specified usage feed to get meditated and rated. The API sends the data asynchronously to the file importer for processing and responds with a tracking identifier for traceability."
},
"Undefined": {
"type": "object",
"properties": {},
"required": []
},
"Reprocess": {
"type": "object",
"properties": {},
"required": []
},
"DataImportCacheCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DataImportCacheCategory",
"readOnly": true,
"type": "number",
"example": 4
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
}
},
"description": "Categories used to enrich mediation data."
},
"DayOfWeekType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DayOfWeekType",
"readOnly": true,
"type": "number",
"example": 4
},
"name": {
"readOnly": true,
"example": "Monday",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 15
}
},
"description": "This system defined entity represents the individual days of the week."
},
"DiscountPromoCode": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DiscountPromoCode",
"readOnly": true,
"type": "number",
"example": 26
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Christmas Promo",
"type": "string"
},
"promoDescription": {
"example": "10% off Set up fees - Christmas Promo",
"type": "string"
},
"discountStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date of the Promo. Date and time values are specified in the ISO 8601 format."
},
"discountEnd": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The end date of the Promo. Date and time values are specified in the ISO 8601 format."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"isProrated": {
"type": "boolean",
"example": "true"
},
"isNegativeAllowed": {
"type": "boolean",
"example": "true"
}
},
"description": "Definition of the Promo Code Discount objects within the system."
},
"DiscountType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the DiscountType",
"readOnly": true,
"type": "number",
"example": 8
},
"name": {
"readOnly": true,
"example": "Percentage",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 17
}
},
"description": "This system defined entity represents a list of different types of discounts. For example percentage or fixed."
},
"EmailSetting": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the EmailSetting",
"readOnly": true,
"type": "number",
"example": 11
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"fromEmailAddress": {
"example": "Hello World",
"type": "string"
},
"fromName": {
"example": "Hello World",
"type": "string"
},
"useSecureConnection": {
"type": "boolean",
"example": "true"
},
"maxAttachmentsSizeInMiB": {
"type": "number",
"example": 1
},
"failureNotificationUserId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated User object."
},
"failureNotificationUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the failureNotificationUserId property."
},
"emailHostTypeId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated EmailHostType object."
},
"emailHostTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the emailHostTypeId property."
},
"emailSettingsKeyName": {
"example": "Hello World",
"type": "string"
}
}
},
"EmailTemplate": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the EmailTemplate",
"readOnly": true,
"type": "number",
"example": 22
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 11,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"emailTemplateTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated EmailTemplateType object."
},
"emailTemplateTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the emailTemplateTypeId property."
},
"description": {
"example": "Hello World",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"subject": {
"example": "Hello World",
"type": "string"
},
"fromName": {
"example": "Hello World",
"type": "string"
},
"fromEmailAddress": {
"example": "Hello World",
"type": "string"
},
"localeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated Locale object."
},
"localeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the localeId property."
},
"eventRegistrationId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated EventRegistration object."
},
"eventRegistrationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the eventRegistrationId property."
},
"tokenContextTypeId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated TokenContextType object."
},
"tokenContextTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the tokenContextTypeId property."
},
"storageLocationId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated StorageLocation object."
},
"storageLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the storageLocationId property."
},
"documentIdentifier": {
"example": "Hello World",
"type": "string"
},
"fileName": {
"example": "Hello World",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
}
}
},
"EmailTemplateType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the EmailTemplateType",
"readOnly": true,
"type": "number",
"example": 3
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"AvailableTokens": {
"type": "object",
"properties": {},
"required": []
},
"EventRegistration": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the EventRegistration",
"readOnly": true,
"type": "number",
"example": 1
},
"eventDtoTypeKey": {
"example": "Hello World",
"type": "string"
},
"eventActionTypeId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated EventActionType object."
},
"eventActionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the eventActionTypeId property."
},
"eventQueueTypeId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated EventQueueType object."
},
"eventQueueTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the eventQueueTypeId property."
},
"isRetrieved": {
"type": "boolean",
"example": "true"
},
"isTracked": {
"type": "boolean",
"example": "true"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"isInternal": {
"type": "boolean",
"example": "true"
},
"name": {
"example": "Hello World",
"type": "string"
},
"tokenContextTypeId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated TokenContextType object."
},
"tokenContextTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the tokenContextTypeId property."
}
}
},
"EventSubscription": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the EventSubscription",
"readOnly": true,
"type": "number",
"example": 24
},
"name": {
"example": "Hello World",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"eventRegistrationId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated EventRegistration object."
},
"eventRegistrationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the eventRegistrationId property."
},
"eventBindingActionId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated EventBindingAction object."
},
"eventBindingActionName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the eventBindingActionId property."
},
"accessTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated AccessType object."
},
"accessTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accessTypeId property."
},
"createdByUserId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updatedByUserId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
}
},
"ExtensionAttribute": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ExtensionAttribute",
"readOnly": true,
"type": "number",
"example": 23
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 20,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "CPQ Order Number",
"type": "string"
},
"hint": {
"example": "The number from your CPQ system",
"type": "string"
},
"description": {
"example": "This is the linking order number from our CPQ system",
"type": "string"
},
"columnName": {
"example": "cpqOrderNumber",
"type": "string"
},
"defaultValue": {
"example": "00000",
"type": "string"
},
"isRequired": {
"type": "boolean",
"example": "true"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"dataSourceColumnDataTypeId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated DataSourceColumnDataType object."
},
"dataSourceColumnDataTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataSourceColumnDataTypeId property."
},
"multiSelectDataSourceColumnDataTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated DataSourceColumnDataType object."
},
"multiSelectDataSourceColumnDataTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the multiSelectDataSourceColumnDataTypeId property."
},
"extensionAttributeEntityId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated ExtensionAttributeEntity object."
},
"extensionAttributeEntityName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the extensionAttributeEntityId property."
},
"isUnique": {
"type": "boolean",
"example": "true"
},
"minValue": {
"example": "5",
"type": "string"
},
"maxValue": {
"example": "500",
"type": "string"
},
"validationDataTypeId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated DataType object."
},
"validationDataTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the validationDataTypeId property."
},
"validationRegEx": {
"example": "^[1-9]\\d{2}-\\d{3}-\\d{4}",
"type": "string"
},
"formula": {
"example": "Hello World",
"type": "string"
},
"extensionAttributeListTypeId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated ExtensionAttributeListType object."
},
"extensionAttributeListTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the extensionAttributeListTypeId property."
},
"createdByUserId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
},
"description": "This entity represents different properties of a Custom Field."
},
"ExtensionAttributeEntity": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ExtensionAttributeEntity",
"readOnly": true,
"type": "number",
"example": 3
},
"name": {
"example": "Hello World",
"type": "string"
},
"tableName": {
"example": "Hello World",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 11
}
}
},
"ExtensionAttributeListItem": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ExtensionAttributeListItem",
"readOnly": true,
"type": "number",
"example": 26
},
"extensionAttributeId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated ExtensionAttribute object."
},
"extensionAttributeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the extensionAttributeId property."
},
"sortOrder": {
"type": "number",
"example": 23
},
"value": {
"example": "My List Item 1",
"type": "string"
}
},
"description": "This entity represents the list of items for a Custom Field defined as a pick list."
},
"ExtensionAttributeListType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ExtensionAttributeListType",
"readOnly": true,
"type": "number",
"example": 11
},
"name": {
"readOnly": true,
"example": "Multi-Select",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 20
}
},
"description": "This internal entity represents if a Custom Field list is either single or multi-select."
},
"ExtensionAttributeLookup": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ExtensionAttributeLookup",
"readOnly": true,
"type": "number",
"example": 26
},
"extensionAttributeId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated ExtensionAttribute object."
},
"extensionAttributeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the extensionAttributeId property."
},
"searchRequest": {
"example": "Hello World",
"type": "string"
},
"columnName": {
"example": "Hello World",
"type": "string"
},
"resourceName": {
"example": "Hello World",
"type": "string"
}
}
},
"FrequencyType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the FrequencyType",
"readOnly": true,
"type": "number",
"example": 23
},
"name": {
"example": "Month",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": "1"
}
},
"description": "This internal entity represents the frequency units used in billing."
},
"GatewayType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the GatewayType",
"readOnly": true,
"type": "number",
"example": 3
},
"name": {
"readOnly": true,
"example": "Authorize.net",
"type": "string"
},
"vendorGatewayTypeName": {
"readOnly": true,
"example": "authorize_net",
"type": "string"
},
"paymentProviderId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated PaymentProvider object."
},
"paymentProviderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentProviderId property."
}
},
"description": "This internal entity represents a Payment Gateway used to process payments."
},
"GeneralLedger": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the GeneralLedger",
"readOnly": true,
"type": "number",
"example": 9
},
"glDebit": {
"example": "cad-debit",
"type": "string"
},
"glCredit": {
"example": "cad-credit",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 9,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"name": {
"example": "Canadian Taxes",
"type": "string"
}
},
"description": "This entity represents the user defined GL codes used within the system."
},
"GeoTreeLocation": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the GeoTreeLocation",
"readOnly": true,
"type": "number",
"example": 5
},
"name": {
"example": "United States",
"type": "string"
},
"depth": {
"readOnly": true,
"type": "number",
"example": 20
}
},
"description": "This entity represents a location with in the GeoTree object used in location rating."
},
"GeoTreeLocationGroup": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the GeoTreeLocationGroup",
"readOnly": true,
"type": "number",
"example": 25
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 18,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Zone 1",
"type": "string"
},
"description": {
"example": "Rates for the Wester Hemisphere",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 26
}
},
"description": "This entity represents a grouping of locations/zones within the GeoTree object used in location rating."
},
"GeoTreeLocationPattern": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the GeoTreeLocationPattern",
"readOnly": true,
"type": "number",
"example": 5
},
"name": {
"example": "01",
"type": "string"
},
"geoTreeLocationId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated GeoTreeLocation object."
},
"geoTreeLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationId property."
},
"country": {
"example": "US",
"type": "string"
},
"state": {
"example": "CA",
"type": "string"
},
"city": {
"example": "LA",
"type": "string"
},
"lata": {
"example": "Hello World",
"type": "string"
}
},
"description": "This entity represents a pattern to use on a mediated record to determine if it belongs to a Location. In telecom a good example of this is the area or country code."
},
"Invoice": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Invoice",
"readOnly": true,
"type": "number",
"example": 10
},
"accountId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The Date Time stamp to appear on the Invoice. Date and time values are specified in the ISO 8601 format."
},
"sent": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The Date Time stamp for when this Invoice was sent to the Account Contact. Date and time values are specified in the ISO 8601 format."
},
"due": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The Date Time for when this Invoice payment is due. Date and time values are specified in the ISO 8601 format."
},
"lastChecked": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"invoiceStatusTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated InvoiceStatusType object."
},
"invoiceStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceStatusTypeId property."
},
"processed": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"billRunHistoryId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated BillRunHistory object."
},
"billRunHistoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunHistoryId property."
},
"previousBalance": {
"type": "number",
"example": 102.52
},
"balance": {
"type": "number",
"example": 202.52
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"closed": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The Date Time stamp for when this Invoice was closed. Date and time values are specified in the ISO 8601 format."
},
"total": {
"type": "number",
"example": 100.15
},
"totalCharge": {
"type": "number",
"example": 100.15
},
"totalTax": {
"type": "number",
"example": 12.15
},
"totalDiscount": {
"type": "number",
"example": 10.36
},
"totalPaymentApplied": {
"type": "number",
"example": 12.36
},
"totalCreditApplied": {
"type": "number",
"example": 11.36
},
"totalPaymentAttached": {
"type": "number",
"example": 7.36
},
"totalCreditAttached": {
"type": "number",
"example": 5.34
},
"baseTotal": {
"type": "number",
"example": 100.15
},
"baseTotalCharge": {
"type": "number",
"example": 100.15
},
"baseTotalDiscount": {
"type": "number",
"example": 10.36
},
"baseTotalPaymentApplied": {
"type": "number",
"example": 12.36
},
"baseTotalCreditApplied": {
"type": "number",
"example": 11.36
},
"baseTotalPaymentAttached": {
"type": "number",
"example": 7.36
},
"baseTotalCreditAttached": {
"type": "number",
"example": 5.34
},
"baseBalance": {
"type": "number",
"example": 5.34
},
"baseTotalTax": {
"type": "number",
"example": 12.15
},
"basePreviousBalance": {
"type": "number",
"example": 102.52
},
"isVoid": {
"type": "boolean",
"example": "true"
},
"isVoiding": {
"type": "boolean",
"example": "true"
},
"doNotDeliver": {
"type": "boolean",
"example": "true"
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"emailDeliverySkipped": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents an Invoice on an Account with related details."
},
"Void": {
"type": "object",
"properties": {},
"required": []
},
"ReRender": {
"type": "object",
"properties": {},
"required": []
},
"Delivery": {
"type": "object",
"properties": {},
"required": []
},
"InvoiceDateProcessType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDateProcessType",
"readOnly": true,
"type": "number",
"example": 7
},
"name": {
"readOnly": true,
"example": "Hello World",
"type": "string"
}
},
"description": "Determines what the invoice date is based on. It let's the user define if the invoice date is based on when the invoice is rendered or when the account is billed."
},
"InvoiceDelivery": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDelivery",
"readOnly": true,
"type": "number",
"example": 15
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 27,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"templateId": {
"type": "number",
"example": 3,
"description": "The invoice template to use with this delivery method. Unique identifier for the associated Template object."
},
"templateName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the templateId property."
},
"emailTemplateId": {
"type": "number",
"example": 21,
"description": "The email template to use with this delivery method. Unique identifier for the associated EmailTemplate object."
},
"emailTemplateName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the emailTemplateId property."
},
"invoiceDeliveryTypeId": {
"type": "number",
"example": 13,
"description": "Specifying if this is email delivery or offline. Unique identifier for the associated InvoiceDeliveryType object."
},
"invoiceDeliveryTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceDeliveryTypeId property."
},
"transferLocationId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated TransferLocation object."
},
"transferLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the transferLocationId property."
},
"doNotEmailZeroChargeInvoice": {
"type": "boolean",
"example": "true"
}
},
"description": "This entity represents the configuration of Invoice delivery details (i.e. via email or offline), and associated templates to be used (i.e. invoice and email delivery templates)."
},
"InvoiceDueDateType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDueDateType",
"readOnly": true,
"type": "number",
"example": 1
},
"name": {
"readOnly": true,
"example": "Hello World",
"type": "string"
}
},
"description": "Determines what the invoice \"due-date\" is based on. It let's the user define if the invoice due-date is based on when the invoice is rendered or when the account bill day. The Due date will also be affected by any dunning rules assigned."
},
"InvoiceExportOptionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceExportOptionType",
"readOnly": true,
"type": "number",
"example": 1
},
"name": {
"readOnly": true,
"example": "Hello World",
"type": "string"
}
},
"description": "Internal invoice file generation type."
},
"InvoiceHistory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceHistory",
"readOnly": true,
"type": "number",
"example": 3
},
"invoiceId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date Time Stamp for this specific historical event. Date and time values are specified in the ISO 8601 format."
},
"action": {
"example": "rendered",
"type": "string"
},
"userId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated User object."
},
"userName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the userId property."
},
"billRunHistoryId": {
"type": "number",
"example": 26,
"description": "The Bill Run that created this invoice event. Unique identifier for the associated BillRunHistory object."
},
"billRunHistoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunHistoryId property."
}
},
"description": "Contains a list of historical actions/events that an Invoice passess through during its lifecycle."
},
"InvoiceItem": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceItem",
"readOnly": true,
"type": "number",
"example": 16
},
"accountId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"packageId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated Package object."
},
"packageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageId property."
},
"serviceId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Service object."
},
"serviceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceId property."
},
"amount": {
"type": "number",
"example": 7
},
"detail": {
"example": "Hello World",
"type": "string"
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date in which this transaction was generated. Date and time values are specified in the ISO 8601 format."
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The end date in which this transaction was generated. Date and time values are specified in the ISO 8601 format."
},
"prorated": {
"type": "boolean",
"example": "true"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date of the charge. Date and time values are specified in the ISO 8601 format."
},
"accountPackageId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountPackage object."
},
"accountPackageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountPackageId property."
},
"accountServiceId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountService object."
},
"accountServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceId property."
},
"posting": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The date for when this charge should be considered posted. Date and time values are specified in the ISO 8601 format."
},
"invoiceId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"invoiceItemTypeId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated InvoiceItemType object."
},
"invoiceItemTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceItemTypeId property."
},
"baseAmount": {
"type": "number",
"example": 6
},
"invoiceAmount": {
"type": "number",
"example": 7
},
"invoiceCurrencyExchangeDetailId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated CurrencyExchangeDetail object."
},
"invoiceCurrencyExchangeDetailName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceCurrencyExchangeDetailId property."
},
"originalInvoiceItemId": {
"type": "number",
"example": 9,
"description": "A reference to the original transaction that was part of a previous voided invoice. Unique identifier for the associated InvoiceItem object."
},
"originalInvoiceItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the originalInvoiceItemId property."
},
"isManual": {
"type": "boolean",
"example": "true"
},
"createdByUserId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"udrUsageIdentifier": {
"example": "Hello World",
"type": "string"
},
"accountServiceTemporalId": {
"example": "Hello World",
"type": "string",
"description": "Unique identifier for the associated AccountServiceTemporal object."
},
"accountServiceTemporalName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceTemporalId property."
},
"quantity": {
"type": "number",
"example": 25
},
"price": {
"type": "number",
"example": 26
},
"generalLedgerId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"serviceTaxCategoryId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"preDiscountAmount": {
"type": "number",
"example": 23
},
"isTaxInclusive": {
"type": "boolean",
"example": "true"
},
"invoicerAccountId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Account object."
},
"invoicerAccountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoicerAccountId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"isTaxedOnCreate": {
"type": "boolean",
"example": "true"
},
"usageValue": {
"example": "Hello World",
"type": "string"
},
"usageUnitId": {
"type": "number",
"example": 19
},
"tierPricePercent": {
"type": "number",
"example": 22
}
},
"description": "This is the billing transaction that is associated with an Invoice."
},
"TaxSummary": {
"type": "object",
"properties": {},
"required": []
},
"InvoiceItemType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceItemType",
"readOnly": true,
"type": "number",
"example": 8
},
"name": {
"example": "Hello World",
"type": "string"
},
"baseInvoiceItemTypeId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated BaseInvoiceItemType object."
},
"baseInvoiceItemTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the baseInvoiceItemTypeId property."
},
"invoiceDetail": {
"example": "Hello World",
"type": "string"
}
},
"description": "A system categorization of different types of Invoice Items. Examples are: recurring, non-recurring, one-time etc."
},
"InvoiceStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceStatusType",
"readOnly": true,
"type": "number",
"example": 14
},
"name": {
"example": "Hello World",
"type": "string"
}
},
"description": "System statuses of an Invoice Item through the billing pipeline. Examples are: taxes, posted, delivered, rendered, voided etc."
},
"InvoiceByUdrMediated": {
"type": "object",
"properties": {},
"description": "Invoice information of an individual mediated usage record."
},
"InvoiceDeliveryType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDeliveryType",
"readOnly": true,
"type": "number",
"example": 24
},
"name": {
"readOnly": true,
"example": "Hello World",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 17
}
},
"description": "System defined delivery type such as \"email\" or \"offline\"."
},
"InvoiceDiscountCalculationType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDiscountCalculationType",
"readOnly": true,
"type": "number",
"example": 14
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"InvoiceDiscountType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the InvoiceDiscountType",
"readOnly": true,
"type": "number",
"example": 12
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"JsonApiLog": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the JsonApiLog",
"readOnly": true,
"type": "string",
"example": "Hello World"
},
"userIdentity": {
"type": "number",
"example": 1
},
"ownerTenantIdentity": {
"type": "number",
"example": 20
},
"user": {
"example": "Hello World",
"type": "string"
},
"requestTrackingIdentity": {
"example": "Hello World",
"type": "string"
},
"utc": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"requestUri": {
"example": "Hello World",
"type": "string"
},
"requestVerb": {
"example": "Hello World",
"type": "string"
},
"requestHeaders": {
"example": "Hello World",
"type": "string"
},
"requestLength": {
"example": "Hello World",
"type": "string"
},
"request": {
"example": "Hello World",
"type": "string"
},
"responseStatusCode": {
"example": "Hello World",
"type": "string"
},
"responseReasonCode": {
"example": "Hello World",
"type": "string"
},
"responseHeaders": {
"example": "Hello World",
"type": "string"
},
"responseLength": {
"example": "Hello World",
"type": "string"
},
"response": {
"example": "Hello World",
"type": "string"
},
"ipAddressFrom": {
"example": "Hello World",
"type": "string"
},
"ipAddressTo": {
"example": "Hello World",
"type": "string"
},
"duration": {
"example": "Hello World",
"type": "string"
},
"idempotencyKey": {
"example": "Hello World",
"type": "string"
}
}
},
"Locale": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Locale",
"readOnly": true,
"type": "number",
"example": 19
},
"name": {
"readOnly": true,
"example": "English",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 21
},
"localeIdentifier": {
"readOnly": true,
"example": "EN",
"type": "string"
}
},
"description": "System defined list of global Locale identifiers."
},
"Note": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Note",
"readOnly": true,
"type": "number",
"example": 15
},
"subject": {
"example": "Delivery Instuctions",
"type": "string"
},
"text": {
"example": "Drop off at rear door.",
"type": "string"
},
"noteTypeId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated NoteType object."
},
"noteTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the noteTypeId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updated": {
"description": "Date time stamp the last time this Note was updated The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"updatedByUserId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"showOnOverview": {
"type": "boolean",
"example": "true"
},
"isImportant": {
"type": "boolean",
"example": "true"
}
},
"description": "Represents a note made on an Account."
},
"NoteType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the NoteType",
"readOnly": true,
"type": "number",
"example": 24
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 20,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"readOnly": true,
"example": "Default",
"type": "string"
}
},
"description": "System defined type for a Note"
},
"Order": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Order",
"readOnly": true,
"type": "number",
"example": 7
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 16,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"accountId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"contactId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated Contact object."
},
"contactName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the contactId property."
},
"invoiceId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"orderStatusTypeId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated OrderStatusType object."
},
"orderStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the orderStatusTypeId property."
},
"companyName": {
"example": "Acme Co.",
"type": "string"
},
"externalIdentifier": {
"example": "124567-23",
"type": "string"
},
"completed": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date Time Stamp that represents when the Order was billed. Date and time values are specified in the ISO 8601 format."
},
"purchaseOrderNumber": {
"example": "PO123454",
"type": "string"
},
"totalAmountEstimate": {
"type": "number",
"example": 456.67
},
"preAuthTransactionIdentifier": {
"example": "236958",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"statusUpdated": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date Time Stamp that represents the last time the orderStatusTypeId was updated. Date and time values are specified in the ISO 8601 format."
},
"priceBookId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
},
"accountContractId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated AccountContract object."
},
"accountContractName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountContractId property."
},
"discountPromoCodeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated DiscountPromoCode object."
},
"discountPromoCodeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the discountPromoCodeId property."
}
},
"description": "Represents the linking of an Order which has been created for an Account."
},
"OrderStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the OrderStatusType",
"readOnly": true,
"type": "number",
"example": 26
},
"name": {
"example": "completed",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": 22
}
},
"description": "Represents the status of an Order. Examples are draft, completed, in-progress etc."
},
"Owner": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Owner",
"readOnly": true,
"type": "number",
"example": 1
},
"name": {
"readOnly": true,
"example": "Default Owner",
"type": "string"
},
"fiscalYearStartingMonth": {
"type": "number",
"example": "1"
},
"amountPrecision": {
"type": "number",
"example": "2"
},
"largeLogo": {
"example": "base64encoded",
"type": "string"
},
"smallLogo": {
"example": "base64encoded",
"type": "string"
},
"primaryColor": {
"example": "#000000",
"type": "string"
},
"secondaryColor": {
"example": "#0000FF",
"type": "string"
},
"dynamicUsageClassExtensionAttributeId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated ExtensionAttribute object."
},
"dynamicUsageClassExtensionAttributeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dynamicUsageClassExtensionAttributeId property."
},
"defaultLocaleId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Locale object."
},
"defaultLocaleName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultLocaleId property."
},
"realTimeUsageTaxation": {
"type": "boolean",
"example": "true"
},
"isCustomerPortalActive": {
"type": "boolean",
"example": "true"
},
"roundingMethodTypeId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated RoundingMethodType object."
},
"roundingMethodTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the roundingMethodTypeId property."
},
"usageBillingGraceDays": {
"type": "number",
"example": "10"
},
"isReportingDatabaseEnabled": {
"type": "boolean",
"example": "true"
},
"displayName": {
"example": "Hello World",
"type": "string"
},
"vatNumber": {
"example": "VAT0001IE",
"type": "string"
},
"bankingReferenceIdentifier": {
"example": "Hello World",
"type": "string"
},
"registrationIdentifier": {
"example": "Hello World",
"type": "string"
},
"electronicInvoiceEndpointIdentifier": {
"example": "Hello World",
"type": "string"
},
"billPrepaidAdjustments": {
"type": "boolean",
"example": true
},
"usageClassResolverIsActive": {
"type": "boolean",
"example": "true"
},
"accountSharePlanProductCodeCustomizationIsActive": {
"type": "boolean",
"example": "true"
}
},
"description": "Represents a business unit or corporate entity within the system. Currently limited to one business unit."
},
"Package": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Package",
"readOnly": true,
"type": "number",
"example": 1
},
"name": {
"example": "Gold Service Plan",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date Time for when this Package is available for purchase. Date and time values are specified in the ISO 8601 format."
},
"expiry": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date Time for when this Package is no longer available for purchase. Date and time values are specified in the ISO 8601 format."
},
"fullPeriod": {
"type": "boolean",
"example": "true"
},
"invoiceDetail": {
"example": "Hello World",
"type": "string"
},
"postPaid": {
"type": "boolean",
"example": "true"
},
"billOnAccountBillDay": {
"type": "boolean",
"example": true
},
"defaultAccountPackageStatusTypeId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated AccountPackageStatusType object."
},
"defaultAccountPackageStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultAccountPackageStatusTypeId property."
},
"packageCategoryId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated PackageCategory object."
},
"packageCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageCategoryId property."
},
"chargeRecurringIfUsage": {
"type": "boolean",
"example": "true"
},
"isGlobalAddOnEligible": {
"type": "boolean",
"example": "true"
},
"description": {
"example": "The best service plan available",
"type": "string"
},
"isQuantityAllowed": {
"type": "boolean",
"example": false
},
"id": {
"type": "number",
"example": 23
}
},
"description": "Packages are products/offerings that are added to accounts and billed. A package contains one or more services, the services are the individual line items that charges are configured on."
},
"PackageCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PackageCategory",
"readOnly": true,
"type": "number",
"example": 19
},
"name": {
"readOnly": true,
"example": "Billing Activation",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 8
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "Represents an internal category for a Package. Examples are \"share plan\", \"billing activation\", \"one time billing\" etc.. These are typically represented by check boxes during configuration."
},
"PackageCurrency": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PackageCurrency",
"readOnly": true,
"type": "number",
"example": 12
},
"packageId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Package object."
},
"packageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageId property."
},
"currencyId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated Currency object."
},
"currencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyId property."
}
},
"description": "Represents a linking of the different currencies in which a Package can be sold."
},
"PackageFrequency": {
"type": "object",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 1200
},
"trackingId": {
"type": [
"string",
"null"
],
"format": "uuid",
"example": "7d9d9d1d-4e7f-4f2d-9f3f-2f7b7b5c1234"
},
"frequency": {
"type": "integer",
"example": 1
},
"isActive": {
"type": "boolean",
"example": true
},
"packageId": {
"type": "integer",
"example": 45
},
"packageName": {
"type": "string",
"example": "Business Fiber"
},
"frequencyTypeId": {
"type": "integer",
"example": 2
},
"frequencyTypeName": {
"type": "string",
"example": "Month"
},
"termId": {
"type": [
"integer",
"null"
],
"example": 12
},
"termName": {
"type": [
"string",
"null"
],
"example": "12 Month"
},
"sku": {
"type": [
"string",
"null"
],
"example": "BF-MONTHLY-12"
},
"name": {
"type": "string",
"example": "Monthly"
},
"isUsageBucketSharePlanPackageFrequency": {
"type": "boolean",
"example": false
},
"countingRuleId": {
"type": [
"integer",
"null"
],
"example": 7
},
"countingRuleName": {
"type": [
"string",
"null"
],
"example": "Standard Monthly Count"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2025-08-08T14:30:00Z"
},
"updated": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2025-10-02T09:15:00Z"
},
"defaultCountingRuleId": {
"type": [
"integer",
"null"
],
"example": 7
},
"defaultCountingRuleName": {
"type": [
"string",
"null"
],
"example": "Standard Monthly Count"
},
"extensions": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": null
},
"details": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": null
}
},
"required": [
"identity",
"frequency",
"isActive",
"packageId",
"packageName",
"frequencyTypeId",
"frequencyTypeName",
"name",
"isUsageBucketSharePlanPackageFrequency",
"created"
],
"description": "Package frequency record describing how often a package is billed or renewed."
},
"PackageFrequencyPackageCurrency": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PackageFrequencyPackageCurrency",
"readOnly": true,
"type": "number",
"example": 8
},
"isActive": {
"type": "boolean",
"example": "true"
},
"packageFrequencyId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated PackageFrequency object."
},
"packageFrequencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageFrequencyId property."
},
"packageCurrencyId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated PackageCurrency object."
},
"packageCurrencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageCurrencyId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"priceBookId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
}
},
"description": "Represents a linking between a Package frequency and currency in which a Package can be sold."
},
"PackageService": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PackageService",
"readOnly": true,
"type": "number",
"example": 19
},
"packageId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated Package object."
},
"packageName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageId property."
},
"serviceId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated Service object."
},
"serviceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceId property."
},
"defaultInstances": {
"type": "number",
"example": 25
},
"minimumInstances": {
"type": "number",
"example": 4
},
"maximumInstances": {
"type": "number",
"example": 13
},
"termId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated Term object."
},
"termName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the termId property."
},
"isUsageBucketSharePlanPackageService": {
"type": "boolean",
"example": "true"
},
"usageClassDynamicId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated UsageClassDynamic object."
},
"usageClassDynamicName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassDynamicId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
}
},
"description": "Represents a linking between Services contained within a Package."
},
"PackageServicePricePlan": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PackageServicePricePlan",
"readOnly": true,
"type": "number",
"example": 11
},
"packageServiceId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated PackageService object."
},
"packageServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageServiceId property."
},
"packageFrequencyId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated PackageFrequency object."
},
"packageFrequencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageFrequencyId property."
},
"packageCurrencyId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PackageCurrency object."
},
"packageCurrencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageCurrencyId property."
},
"accountPricePlanId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated AccountPricePlan object."
},
"accountPricePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountPricePlanId property."
},
"accountProductCodeId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated AccountProductCode object."
},
"accountProductCodeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountProductCodeId property."
},
"priceBookId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
},
"pricePlanTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated PricePlanType object."
},
"pricePlanTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the pricePlanTypeId property."
},
"effective": {
"example": "Hello World",
"type": "string"
},
"priceChangeTrackingId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated PriceChangeTracking object."
},
"priceChangeTrackingName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceChangeTrackingId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
}
},
"description": "Represents the linking of pricing for a Service assigned to a Package."
},
"DiscountRank": {
"type": "object",
"properties": {},
"required": []
},
"Payment": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Payment",
"readOnly": true,
"type": "number",
"example": 13
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date the payment was made. Date and time values are specified in the ISO 8601 format."
},
"amount": {
"type": "number",
"example": 1235.89
},
"accountId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"disbursed": {
"type": "boolean",
"example": "true"
},
"paymentTypeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated PaymentType object."
},
"paymentTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTypeId property."
},
"detail": {
"example": "Payment Recieved",
"type": "string"
},
"cardTypeId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated CardType object."
},
"cardTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the cardTypeId property."
},
"checkNumber": {
"example": "1236-9658",
"type": "string"
},
"automaticDisburse": {
"type": "boolean",
"example": "true"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"invoiceId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated Invoice object."
},
"invoiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the invoiceId property."
},
"posting": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date the payment should be shown as posted. Date and time values are specified in the ISO 8601 format."
},
"baseAmount": {
"type": "number",
"example": 1345.89
},
"invoiceAmount": {
"type": "number",
"example": 20
},
"currencyExchangeDetailId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated CurrencyExchangeDetail object."
},
"currencyExchangeDetailName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyExchangeDetailId property."
},
"billRunHistoryId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated BillRunHistory object."
},
"billRunHistoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the billRunHistoryId property."
},
"isManual": {
"type": "boolean",
"example": "true"
},
"reversePaymentId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated Payment object."
},
"reversePaymentName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the reversePaymentId property."
},
"createdByUserId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"paymentMethodId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PaymentMethod object."
},
"paymentMethodName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentMethodId property."
},
"paymentPreAuthorizeId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated PaymentPreAuthorize object."
},
"paymentPreAuthorizeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentPreAuthorizeId property."
},
"paymentTransactionId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated PaymentTransaction object."
},
"paymentTransactionName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTransactionId property."
},
"createdByPortalUserId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated PortalUser object."
},
"createdByPortalUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByPortalUserId property."
},
"paymentStatusTypeId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated PaymentStatusType object."
},
"paymentStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentStatusTypeId property."
},
"retryPaymentId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Payment object."
},
"retryPaymentName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the retryPaymentId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"paymentTransactionTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PaymentTransactionType object."
},
"paymentTransactionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTransactionTypeId property."
}
},
"description": "Represents a Payment that has been made on an account."
},
"PaymentActionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentActionType",
"readOnly": true,
"type": "number",
"example": 5
},
"name": {
"readOnly": true,
"example": "Apply late fee",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 7
}
},
"description": "System actions that are taken during the dunning process such as \"apply late fee\"."
},
"PaymentDunningRule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentDunningRule",
"readOnly": true,
"type": "number",
"example": 22
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 14,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Apply Late Fee",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"minimumOverdue": {
"type": "number",
"example": 1456
}
},
"description": "Represents user defined dunning rules."
},
"PaymentPreAuthorize": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentPreAuthorize",
"readOnly": true,
"type": "number",
"example": 14
},
"paymentMethodId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated PaymentMethod object."
},
"paymentMethodName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentMethodId property."
},
"amount": {
"type": "number",
"example": 200.5
},
"transactionToken": {
"example": "123kjsf90832fwf",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
}
},
"description": "Represents a pre-authorization request for a payment gateway."
},
"PaymentTerm": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentTerm",
"readOnly": true,
"type": "number",
"example": 14
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Net30",
"type": "string"
},
"paymentTermTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PaymentTermType object."
},
"paymentTermTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTermTypeId property."
},
"value": {
"type": "number",
"example": 1
}
},
"description": "Specfies how many days that a customer has to pay an invoice. For example Net30."
},
"PaymentTermType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentTermType",
"readOnly": true,
"type": "number",
"example": 20
},
"name": {
"readOnly": true,
"example": "Net",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 20
}
},
"description": "System defined types of payment terms such as Day of Month, Net or on Due Date."
},
"PaymentBaseType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentBaseType",
"readOnly": true,
"type": "number",
"example": 4
},
"name": {
"readOnly": true,
"example": "ACH",
"type": "string"
},
"vendorPaymentType": {
"readOnly": true,
"example": "credit_card",
"type": "string"
}
},
"description": "System defined types of payment types such as Credit Card, ACH or Cash."
},
"PaymentGateway": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentGateway",
"readOnly": true,
"type": "number",
"example": 18
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 17,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"gatewayToken": {
"example": "Hello World",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
},
"gatewayTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated GatewayType object."
},
"gatewayTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the gatewayTypeId property."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"isCvvRequired": {
"type": "boolean",
"example": "true"
},
"apiKeyName": {
"example": "Hello World",
"type": "string"
},
"paymentApiUrl": {
"example": "Hello World",
"type": "string"
},
"managementApiUrl": {
"example": "Hello World",
"type": "string"
},
"is3DS2Enabled": {
"type": "boolean",
"example": "true"
},
"productionUrlPrefix": {
"example": "Hello World",
"type": "string"
},
"paymentGatewayCaptureTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated PaymentGatewayCaptureType object."
},
"paymentGatewayCaptureTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentGatewayCaptureTypeId property."
}
}
},
"PaymentMethod": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentMethod",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Corporate AMEX",
"type": "string"
},
"paymentTypeId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated PaymentType object."
},
"paymentTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTypeId property."
},
"accountId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"description": {
"example": "This is the main corporate credit card",
"type": "string"
},
"paymentMethodIdentifier": {
"example": "XXXX-XXXX-XXXX-1111",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"autopay": {
"type": "boolean",
"example": "true"
},
"transactionToken": {
"example": "WuJNFtr3HYNWHAVKvflOhOT2JCF",
"type": "string"
},
"attributes": {
"example": "Hello World",
"type": "string"
},
"paymentProviderId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated PaymentProvider object."
},
"paymentProviderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentProviderId property."
},
"paymentMethodToken": {
"example": "127dfh72y3gg",
"type": "string"
},
"cardExpiration": {
"example": "Hello World",
"type": "string"
},
"deactivationReasonTypeId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated DeactivationReasonType object."
},
"deactivationReasonTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the deactivationReasonTypeId property."
}
},
"description": "Defines a configured payment method for an account."
},
"SetAsDefault": {
"type": "object",
"properties": {},
"required": []
},
"PaymentStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentStatusType",
"readOnly": true,
"type": "number",
"example": 9
},
"name": {
"example": "Authorized",
"type": "string"
}
},
"description": "Defined Payment Status Types usded with in the system."
},
"PaymentTransactionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentTransactionType",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"PaymentType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PaymentType",
"readOnly": true,
"type": "number",
"example": 22
},
"name": {
"example": "Bank Draft",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"generalLedgerId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"paymentBaseTypeId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated PaymentBaseType object."
},
"paymentBaseTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentBaseTypeId property."
},
"paymentTypeDisbursementTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated PaymentTypeDisbursementType object."
},
"paymentTypeDisbursementTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentTypeDisbursementTypeId property."
},
"description": {
"example": "Direct deposit of a Bank Draft",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"paymentGatewayId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated PaymentGateway object."
},
"paymentGatewayName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentGatewayId property."
},
"cardTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated CardType object."
},
"cardTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the cardTypeId property."
},
"paymentProviderId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated PaymentProvider object."
},
"paymentProviderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the paymentProviderId property."
}
},
"description": "User defined Payment Type that is a derivative of a Payment Base Type."
},
"PriceBook": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceBook",
"readOnly": true,
"type": "number",
"example": 8
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 21,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Authorized",
"type": "string"
},
"priceBookRegionId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated PriceBookRegion object."
},
"priceBookRegionName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookRegionId property."
},
"description": {
"example": "Authorized",
"type": "string"
},
"isStandard": {
"type": "boolean",
"example": true
},
"isActive": {
"type": "boolean",
"example": true
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
},
"description": "Price books allow packages to be setup with different pricing across multiple currencies in different regions that you define.."
},
"PriceBookRegion": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceBookRegion",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Zone 1",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": true
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
},
"description": "Price books allow packages to be setup with different pricing across multiple currencies in different regions that you define.."
},
"PriceChange": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceChange",
"readOnly": true,
"type": "number",
"example": 26
},
"name": {
"example": "Hello World",
"type": "string"
},
"priceChangeStatusTypeId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PriceChangeStatusType object."
},
"priceChangeStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceChangeStatusTypeId property."
},
"priceBookId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
},
"effective": {
"example": "Hello World",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"updatedByUserId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {}
}
},
"Process": {
"type": "object",
"properties": {},
"required": []
},
"Approve": {
"type": "object",
"properties": {},
"required": []
},
"Rollback": {
"type": "object",
"properties": {},
"required": []
},
"Pricing": {
"type": "object",
"properties": {},
"required": []
},
"PriceChangeCriteriaPriceType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceChangeCriteriaPriceType",
"readOnly": true,
"type": "number",
"example": 15
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"PriceChangeStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceChangeStatusType",
"readOnly": true,
"type": "number",
"example": 12
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"PriceChangeTracking": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceChangeTracking",
"readOnly": true,
"type": "number",
"example": 23
},
"priceChangeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated PriceChange object."
},
"priceChangeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceChangeId property."
},
"priceChangeStatusTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated PriceChangeStatusType object."
},
"priceChangeStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceChangeStatusTypeId property."
},
"errorMessage": {
"example": "Hello World",
"type": "string"
},
"started": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"completed": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
}
},
"PriceChangeType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PriceChangeType",
"readOnly": true,
"type": "number",
"example": 6
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"PricePlanTierType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PricePlanTierType",
"readOnly": true,
"type": "number",
"example": 5
},
"name": {
"readOnly": true,
"example": "Tiered Bracketed",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 13
}
},
"description": "System defined options for tiered pricing such as not-tiered, bracketed, or progressive."
},
"PricePlanType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the PricePlanType",
"readOnly": true,
"type": "number",
"example": 9
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"RatePlan": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the RatePlan",
"readOnly": true,
"type": "number",
"example": 17
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Gold Rate Plan",
"type": "string"
},
"displayName": {
"example": "Hello World",
"type": "string"
},
"isDeleted": {},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"deletedByUserId": {}
},
"description": "Rate plans contain rate groups and rate groups contain rates."
},
"ReportDefinition": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ReportDefinition",
"readOnly": true,
"type": "number",
"example": 24
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"readOnly": true,
"example": "Montly Sales Summary",
"type": "string"
},
"reportFolderId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated ReportFolder object."
},
"reportFolderName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the reportFolderId property."
},
"title": {
"readOnly": true,
"example": "Montly Sales Results",
"type": "string"
},
"repeatTitle": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isLocked": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isActive": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"updatedByUserId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"reportDefinitionTypeId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated ReportDefinitionType object."
},
"reportDefinitionTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the reportDefinitionTypeId property."
},
"useReportingDatabase": {
"type": "boolean",
"example": "true"
}
},
"description": "List of reports that have been defined in the system."
},
"LastGenerated": {
"type": "object",
"properties": {},
"required": []
},
"Generated": {
"type": "object",
"properties": {},
"required": []
},
"Render": {
"type": "object",
"properties": {},
"required": []
},
"DownloadLastGenerated": {
"type": "object",
"properties": {},
"required": []
},
"RerateSchedule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the RerateSchedule",
"readOnly": true,
"type": "number",
"example": 2
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 8,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"complete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"rerateScheduleStatusTypeId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated RerateScheduleStatusType object."
},
"rerateScheduleStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateScheduleStatusTypeId property."
}
}
},
"ViewReratePending": {
"type": "object",
"properties": {
"accountId": {
"type": "number",
"example": 11
},
"accountName": {
"example": "Hello World",
"type": "string"
},
"usageInvoicerAccountId": {
"type": "number",
"example": 8
},
"usageInvoicerAccountName": {
"example": "Hello World",
"type": "string"
},
"earliestStartDate": {
"example": "Hello World",
"type": "string"
},
"rerateTypeId": {
"type": "number",
"example": 2
},
"earliestRerateReasonTypeId": {
"type": "number",
"example": 2
}
}
},
"RerateScheduleTracking": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the RerateScheduleTracking",
"readOnly": true,
"type": "number",
"example": 22
},
"rerateScheduleId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated RerateSchedule object."
},
"rerateScheduleName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateScheduleId property."
},
"accountId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"rerateScheduleStatusTypeId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated RerateScheduleStatusType object."
},
"rerateScheduleStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateScheduleStatusTypeId property."
},
"rerateReasonTypeId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated RerateReasonType object."
},
"rerateReasonTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateReasonTypeId property."
},
"rerateStart": {
"example": "Hello World",
"type": "string"
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"queued": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"complete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"queuedCount": {
"type": "number",
"example": 13
},
"processedCount": {
"type": "number",
"example": 14
},
"maxUsageRatedId": {
"example": "Hello World",
"type": "string"
},
"accountRerateInitializationStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"accountRerateInitializationComplete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"accountRerateStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"usageManagerQueuingSeconds": {
"type": "number",
"example": 13
},
"rerateInitializationSeconds": {
"type": "number",
"example": 12
},
"rerateSeconds": {
"type": "number",
"example": 10
}
}
},
"Rerate": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Rerate",
"readOnly": true,
"type": "number",
"example": 26
},
"rerateScheduleId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated RerateSchedule object."
},
"rerateScheduleName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateScheduleId property."
},
"accountId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Account object."
},
"accountName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountId property."
},
"rerateStart": {
"example": "2026-01-01",
"type": "string"
},
"rerateTypeId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated RerateType object."
},
"rerateTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateTypeId property."
},
"createdByUserId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"rerateReasonTypeId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated RerateReasonType object."
},
"rerateReasonTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the rerateReasonTypeId property."
},
"entityIdentifier": {
"readOnly": true,
"example": "123-456-789",
"type": "string"
}
},
"description": "This path is used to request a rerate of usage data in the system. It can be for either a single account or a batch of accounts."
},
"RoundingMethodType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the RoundingMethodType",
"readOnly": true,
"type": "number",
"example": 2
},
"name": {
"readOnly": true,
"example": "Round up",
"type": "string"
}
},
"description": "System defined options for price rounding such as round up or round half up."
},
"Schedule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Schedule",
"readOnly": true,
"type": "number",
"example": 15
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Import Exception Retry",
"type": "string"
},
"firstScheduleStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date the Schedule was first run. Date and time values are specified in the ISO 8601 format."
},
"scheduleEventTypeId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated ScheduleEventType object."
},
"scheduleEventTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the scheduleEventTypeId property."
},
"scheduleStatusTypeId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated ScheduleStatusType object."
},
"scheduleStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the scheduleStatusTypeId property."
},
"frequency": {
"type": "number",
"example": "1"
},
"monthlyRecurTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated MonthlyRecurType object."
},
"monthlyRecurTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the monthlyRecurTypeId property."
},
"scheduleData": {
"example": "Hello World",
"type": "string"
},
"scheduleFrequencyTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated ScheduleFrequencyType object."
},
"scheduleFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the scheduleFrequencyTypeId property."
}
},
"description": "System defined schedules for all jobs."
},
"Service": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Service",
"readOnly": true,
"type": "number",
"example": 2
},
"name": {
"example": "Activation Fee",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"serviceTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated ServiceType object."
},
"serviceTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTypeId property."
},
"usageFrequency": {
"type": "number",
"example": 7
},
"usageFrequencyTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated FrequencyType object."
},
"usageFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageFrequencyTypeId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"isTaxExempt": {
"type": "boolean",
"example": "true"
},
"isTaxInclusive": {
"type": "boolean",
"example": "true"
},
"generalLedgerId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"taxCodeId": {
"readOnly": true,
"type": "number",
"example": 15,
"description": "Unique identifier for the associated TaxCode object."
},
"taxCodeName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxCodeId property."
},
"serviceTaxCategoryId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"defaultServiceStatusTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated ServiceStatusType object."
},
"defaultServiceStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultServiceStatusTypeId property."
},
"serviceCategoryId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated ServiceCategory object."
},
"serviceCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceCategoryId property."
},
"description": {
"example": "One time charge for activation",
"type": "string"
},
"id": {
"type": "number",
"example": 12
}
},
"description": "Represents Service definition which represents a chargable item that can be attached to a Package."
},
"ServiceBaseType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceBaseType",
"readOnly": true,
"type": "number",
"example": 9
},
"name": {
"readOnly": true,
"example": "Recurring Charge",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 19
},
"tokenName": {
"readOnly": true,
"example": "Hello World",
"type": "string"
}
},
"description": "Represents an internal base type such as \"recurring charge\", \"non-recurring charge\" or \"fee\"."
},
"ServiceCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceCategory",
"readOnly": true,
"type": "number",
"example": 21
},
"name": {
"readOnly": true,
"example": "Share Plan",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 18
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "Represents an internal Category such as \"share plan\", \"default\" etc."
},
"ServiceStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceStatusType",
"readOnly": true,
"type": "number",
"example": 0
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 18,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Currently Active",
"type": "string"
},
"preventChanges": {
"type": "boolean",
"example": "true"
},
"baseBillingStatusTypeId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated BaseBillingStatusType object."
},
"baseBillingStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the baseBillingStatusTypeId property."
}
},
"description": "User defined Status Types for a service that is tied to base types such as \"billable\", \"cancelled\" etc."
},
"ServiceTaxCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceTaxCategory",
"readOnly": true,
"type": "number",
"example": 16
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Land Line Taxable",
"type": "string"
}
},
"description": "User defined Tax Category to be assigned to a Tax Codes."
},
"ServiceTransition": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceTransition",
"readOnly": true,
"type": "number",
"example": 25
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 23,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Suspended",
"type": "string"
},
"fromServiceStatusTypeId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated ServiceStatusType object."
},
"fromServiceStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the fromServiceStatusTypeId property."
},
"toServiceStatusTypeId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated ServiceStatusType object."
},
"toServiceStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the toServiceStatusTypeId property."
}
},
"description": "User defined representation of changing from one Status to another Status."
},
"ServiceType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the ServiceType",
"readOnly": true,
"type": "number",
"example": 4
},
"name": {
"example": "Monthly Fee",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"serviceBaseTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated ServiceBaseType object."
},
"serviceBaseTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceBaseTypeId property."
}
},
"description": "User defined service type that is then tied to lower base types such \"fee\", \"recurring\" etc."
},
"SharePlanType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the SharePlanType",
"readOnly": true,
"type": "number",
"example": 24
},
"name": {
"example": "Usage",
"type": "string"
}
},
"description": "The types of Share Plans avaialable in the system."
},
"State": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the State",
"readOnly": true,
"type": "number",
"example": 13
},
"countryId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated Country object."
},
"countryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the countryId property."
},
"name": {
"example": "California",
"type": "string"
},
"sortOrder": {
"type": "number",
"example": "1"
},
"code": {
"example": "CA",
"type": "string"
},
"isVisible": {
"type": "boolean",
"example": true
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
}
},
"description": "The regional states defined in the system."
},
"StatusTierType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the StatusTierType",
"readOnly": true,
"type": "number",
"example": 25
},
"name": {
"example": "Per Status",
"type": "string"
}
},
"description": "The status tier types defined in the system."
},
"StatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the StatusType",
"readOnly": true,
"type": "number",
"example": 3
},
"name": {
"example": "Active",
"type": "string"
}
},
"description": "The status types defined in the system."
},
"TaxCategory": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxCategory",
"readOnly": true,
"type": "number",
"example": 25
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 10,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"TaxCode": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxCode",
"readOnly": true,
"type": "number",
"example": 23
},
"countryId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated Country object."
},
"countryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the countryId property."
},
"stateId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated State object."
},
"stateName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the stateId property."
},
"name": {
"example": "Texas Taxes",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 17,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"accountTaxCategoryId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated AccountTaxCategory object."
},
"accountTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountTaxCategoryId property."
},
"serviceTaxCategoryId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"taxVendorId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated TaxVendor object."
},
"taxVendorName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxVendorId property."
},
"isReverseVat": {
"type": "boolean",
"example": "true"
},
"displayName": {
"example": "State Taxes",
"type": "string"
},
"isUsageTaxOnly": {
"type": "boolean",
"example": "true"
}
},
"description": "Represents a container that holds a set of the Tax Rates such as \"Texas Taxes\""
},
"TaxExemptLevel": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxExemptLevel",
"readOnly": true,
"type": "number",
"example": 17
},
"name": {
"readOnly": true,
"example": "Federal",
"type": "string"
}
},
"description": "System defined exemption levels such as all, federal, local or state. These work in coordination with a 3rd party tax integration such as AvaTax."
},
"TaxExemptType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxExemptType",
"readOnly": true,
"type": "number",
"example": 26
},
"name": {
"readOnly": true,
"example": "Harmonized Sales Tax",
"type": "string"
}
},
"description": "System defined exemption types which are typically populated by a 3rd party tax integration such as AvaTax."
},
"TaxRate": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxRate",
"readOnly": true,
"type": "number",
"example": 27
},
"rate": {
"type": "number",
"example": 1.13
},
"name": {
"example": "VAT",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 3,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"generalLedgerId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"displayName": {
"example": "VAT",
"type": "string"
},
"taxOnTax": {
"type": "boolean",
"example": "true"
},
"systemGenerated": {
"type": "boolean",
"example": "true"
},
"taxCategoryId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated TaxCategory object."
},
"taxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxCategoryId property."
},
"taxRateCalculationTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated TaxRateCalculationType object."
},
"taxRateCalculationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxRateCalculationTypeId property."
}
},
"description": "Represents an individual tax rate within the system."
},
"TaxType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxType",
"readOnly": true,
"type": "number",
"example": 8
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 2,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"TaxVendor": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxVendor",
"readOnly": true,
"type": "number",
"example": 25
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "AvaTax",
"type": "string"
},
"companyIdentifier": {
"example": "logisense_co",
"type": "string"
},
"uRL": {
"example": "https://mytaxintegrator.com/integrate",
"type": "string"
},
"clientId": {
"example": "12313-13123-3123",
"type": "string"
},
"clientProfileId": {
"example": "12313-13123-3123",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"taxVendorServiceClassId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated TaxVendorServiceClass object."
},
"taxVendorServiceClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxVendorServiceClassId property."
},
"taxVendorBusinessClassId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated TaxVendorBusinessClass object."
},
"taxVendorBusinessClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxVendorBusinessClassId property."
},
"taxVendorTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated TaxVendorType object."
},
"taxVendorTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the taxVendorTypeId property."
},
"defaultAccountTaxCategoryId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated AccountTaxCategory object."
},
"defaultAccountTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultAccountTaxCategoryId property."
},
"defaultServiceTaxCategoryId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"defaultServiceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultServiceTaxCategoryId property."
},
"userKeyName": {
"example": "Hello World",
"type": "string"
},
"passwordKeyName": {
"example": "Hello World",
"type": "string"
},
"facilities": {
"type": "boolean",
"example": "true"
},
"franchise": {
"type": "boolean",
"example": "true"
},
"regulated": {
"type": "boolean",
"example": "true"
}
},
"description": "Represents a list of tax vendors including LogiSense or a 3rd party integration."
},
"TaxVendorBusinessClass": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxVendorBusinessClass",
"readOnly": true,
"type": "number",
"example": 24
},
"name": {
"readOnly": true,
"example": "Default",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 25
}
},
"description": "System defined business classes for Taxation. This is typically defined by the tax integration vendor for tax mapping purposes."
},
"TaxVendorServiceClass": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxVendorServiceClass",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"readOnly": true,
"example": "Default",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 11
}
},
"description": "System defined service classes for Taxation. This is typically defined by the tax integration vendor for tax mapping purposes."
},
"TaxVendorType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxVendorType",
"readOnly": true,
"type": "number",
"example": 26
},
"name": {
"readOnly": true,
"example": "Avalara",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 1
}
},
"description": "System defined list of Taxation integration vendor Types. For example internal or external taxation vendors."
},
"TaxRateCalculationType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TaxRateCalculationType",
"readOnly": true,
"type": "number",
"example": 17
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"Template": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Template",
"readOnly": true,
"type": "number",
"example": 24
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 14,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "12 months",
"type": "string"
},
"dateFormat": {
"example": "dd-MMM-yyyy",
"type": "string"
},
"dateTimeFormat": {
"example": "dd-MMM-yyyy HH:mm:ss",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
},
"localeId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Locale object."
},
"localeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the localeId property."
},
"currencyPrecision": {
"type": "number",
"example": "2"
},
"createdByUserId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updatedByUserId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"templateTypeId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated TemplateType object."
},
"templateTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the templateTypeId property."
},
"excludeZeroValueInvoiceItems": {
"type": "boolean",
"example": "true"
},
"documentStorageLocationId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated StorageLocation object."
},
"documentStorageLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the documentStorageLocationId property."
},
"fileName": {
"example": "Hello World",
"type": "string"
},
"documentIdentifier": {
"example": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"type": "string"
},
"isCore": {
"type": "boolean",
"example": "true"
}
},
"description": "Details of user defined templates within the system."
},
"Term": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the Term",
"readOnly": true,
"type": "number",
"example": 10
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 16,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "12 months",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
},
"frequency": {
"type": "number",
"example": "1"
},
"frequencyTypeId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated FrequencyType object."
},
"frequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the frequencyTypeId property."
},
"penaltyServiceId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated Service object."
},
"penaltyServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the penaltyServiceId property."
},
"chargeRemainder": {
"type": "boolean",
"example": "true"
},
"termRenewalTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated TermRenewalType object."
},
"termRenewalTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the termRenewalTypeId property."
},
"renewTermId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated Term object."
},
"renewTermName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the renewTermId property."
},
"revokeDiscounts": {
"type": "boolean",
"example": "true"
}
},
"description": "User defined terms for Package contracts."
},
"TermType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TermType",
"readOnly": true,
"type": "number",
"example": 18
},
"name": {
"readOnly": true,
"example": "Fixed Term",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 17
}
},
"description": "System defined list of term types such as Fixed or Variable."
},
"TierCalculationType": {
"type": "object",
"properties": {
"identity": {
"description": "Unique identifier for the tier calculation type.",
"readOnly": true,
"type": "integer",
"example": 1
},
"name": {
"example": "Block",
"type": "string",
"description": "Display name of the tier calculation type."
}
},
"description": "Lookup value that controls how a tiered calculation is evaluated."
},
"TierChargeType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the TierChargeType",
"readOnly": true,
"type": "number",
"example": 8
},
"name": {
"example": "My Tier Charge Type",
"type": "string"
}
},
"description": "Allows the charge types configured on pricing tiers to be retrieved ('Fixed Amount' or 'Percentage Off of Base Price'). As of 10.8.5.0 a new percentage based tier type has been introduced which allows a base price to be defined along with percentage discounts per each tier."
},
"AccountMonthlyUsageSummary": {
"type": "object",
"properties": {}
},
"MonthlyUsageSummary": {
"type": "object",
"properties": {},
"required": []
},
"UDRFeed": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UDRFeed",
"readOnly": true,
"type": "number",
"example": 24
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 4,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Hello World",
"type": "string"
},
"description": {
"example": "Hello World",
"type": "string"
},
"enabled": {
"type": "boolean",
"example": "true"
},
"location": {
"example": "Hello World",
"type": "string"
},
"dataProfileId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated DataProfile object."
},
"dataProfileName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the dataProfileId property."
},
"apiName": {
"example": "Hello World",
"type": "string"
}
}
},
"UDRMediated": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Date and time values are specified in the ISO 8601 format."
},
"udrIdentifierTypeId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated UDRIdentifierType object."
},
"udrName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the udrIdentifierTypeId property."
},
"originatingIdentifier": {
"example": "016243802",
"type": "string"
},
"terminatingIdentifier": {
"example": "017675442",
"type": "string"
},
"udrUsageIdentifier": {
"example": "EC-1",
"type": "string"
},
"value": {
"example": "Hello World",
"type": "string"
},
"reverseRating": {
"type": "boolean",
"example": "true"
},
"usageClassId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated UsageClass object."
},
"usageClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassId property."
},
"usageClassGroupTypeId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated UsageClassGroupType object."
},
"usageClassGroupTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassGroupTypeId property."
},
"uniquenessIdentifier": {
"example": "9195d64c5acd24fc0500AAAAAAA",
"type": "string"
},
"usageClassTypeId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated UsageClassType object."
},
"usageClassTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassTypeId property."
},
"importBatchId": {
"type": "number",
"example": 5,
"description": "Unique identifier for the associated ImportBatch object."
},
"importBatchName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the importBatchId property."
},
"usageBill": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "TBC Date and time values are specified in the ISO 8601 format."
},
"inbound": {
"type": "boolean",
"example": "true"
},
"candidateTerminatingIdentifiers": {
"example": "Hello World",
"type": "string"
},
"primaryDataRow": {
"type": "number",
"example": 7
},
"charge": {
"type": "number",
"example": 1
},
"serviceTaxCategoryId": {
"type": "number",
"example": 23,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"id": {
"example": "Hello World",
"type": "string"
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"updatedByUserId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
}
},
"description": "Details of usage records mediated within the system."
},
"UDRUsageBucket": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UDRUsageBucket",
"readOnly": true,
"type": "number",
"example": 22
},
"accountServiceUsageBucketId": {
"type": "number",
"example": 4,
"description": "Unique identifier for the associated AccountServiceUsageBucket object."
},
"accountServiceUsageBucketName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the accountServiceUsageBucketId property."
},
"amount": {
"type": "number",
"example": 3
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Start date in which this Bucket was active during the period. Date and time values are specified in the ISO 8601 format."
},
"end": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "End date for this Bucket during the period. Date and time values are specified in the ISO 8601 format."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
}
},
"description": "Represents the amount used from a Bucket that is assigned to an Account Service."
},
"UsageBaseUnit": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBaseUnit",
"readOnly": true,
"type": "number",
"example": 19
},
"name": {
"readOnly": true,
"example": "Data",
"type": "string"
},
"description": {
"readOnly": true,
"example": "Data calculated rates",
"type": "string"
},
"baseUnit": {
"readOnly": true,
"example": "bytes",
"type": "string"
},
"baseUnitDescription": {
"readOnly": true,
"example": "Calculated at the Byte level.",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 24
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "Internal pick list for the different types of base usage that can be rated. Examples are count, data or time. "
},
"UsageBucket": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucket",
"readOnly": true,
"type": "number",
"example": 5
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "100 minutes",
"type": "string"
},
"prorate": {
"type": "boolean",
"example": "true"
},
"isInfiniteLastTier": {
"type": "boolean",
"example": "true"
},
"isThresholdPerAccountService": {
"type": "boolean",
"example": "true"
},
"usageBucketRefillTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated UsageBucketRefillType object."
},
"usageBucketRefillTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketRefillTypeId property."
},
"refillFrequency": {
"type": "number",
"example": 1
},
"refillFrequencyTypeId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated FrequencyType object."
},
"refillFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the refillFrequencyTypeId property."
},
"expireAfterFrequency": {
"type": "number",
"example": 3
},
"expireAfterFrequencyTypeId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated FrequencyType object."
},
"expireAfterFrequencyTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the expireAfterFrequencyTypeId property."
},
"isAssociatedWithSharePlan": {
"type": "boolean",
"example": "true"
},
"expireAfterRecurrence": {
"type": "number",
"example": 0
},
"accountPackageActivation": {
"type": "boolean",
"example": "true"
},
"usageBucketBaseUnitId": {
"type": "number",
"example": 27,
"description": "Unique identifier for the associated UsageBucketBaseUnit object."
},
"usageBucketBaseUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketBaseUnitId property."
},
"overageUsageRatePlanId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated UsageRatePlan object."
},
"overageUsageRatePlanName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the overageUsageRatePlanId property."
}
},
"description": "Represents an allocation of usage that can be included in pricing, have tiers of usage and overage charges."
},
"UsageBucketBase": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketBase",
"readOnly": true,
"type": "number",
"example": 7
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 2,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Data Bucket for Western Europe",
"type": "string"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "Unused Date and time values are specified in the ISO 8601 format."
},
"end": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "When flagged as retired this end date will be marked and can no longer be used. Date and time values are specified in the ISO 8601 format."
},
"retired": {
"type": "boolean",
"example": "true"
},
"usageBucketBaseUnitId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated UsageBucketBaseUnit object."
},
"usageBucketBaseUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketBaseUnitId property."
}
},
"description": "Defines the base unit of measure for a Bucket such as Time, Data or Count. New Bucket definitions derrive from a Base Bucket."
},
"UsageBucketBaseDetail": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketBaseDetail",
"readOnly": true,
"type": "number",
"example": 5
},
"usageBucketBaseId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageBucketBase object."
},
"usageBucketBaseName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketBaseId property."
},
"usageClassId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated UsageClass object."
},
"usageClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassId property."
},
"geoTreeLocationId": {
"type": "number",
"example": 11,
"description": "Unique identifier for the associated GeoTreeLocation object."
},
"geoTreeLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationId property."
},
"exclude": {
"type": "boolean",
"example": "true"
},
"geoTreeLocationGroupId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated GeoTreeLocationGroup object."
},
"geoTreeLocationGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationGroupId property."
}
},
"description": "Depending Base Bucket this entity allows for specification of Classes or Locations that are either included or excluded from the Base Bucket."
},
"UsageBucketBaseUnit": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketBaseUnit",
"readOnly": true,
"type": "number",
"example": 1
},
"usageBaseUnitId": {
"type": "number",
"example": 13,
"description": "Unique identifier for the associated UsageBaseUnit object."
},
"usageBaseUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBaseUnitId property."
},
"name": {
"readOnly": true,
"example": "Count",
"type": "string"
},
"description": {
"readOnly": true,
"example": "Counting items",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 10
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isBaseBucketEligible": {
"type": "boolean",
"example": "true"
}
},
"description": "System defined unit of counting in a Base Bucket such as Count, Data or Time."
},
"UsageBucketRefillType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketRefillType",
"readOnly": true,
"type": "number",
"example": 27
},
"name": {
"readOnly": true,
"example": "Recurring",
"type": "string"
}
},
"description": "System defined list of refill types for a Bucket. Such as recurring, recuring with rollover and non-recurring."
},
"UsageBucketShareLevel": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketShareLevel",
"readOnly": true,
"type": "number",
"example": 11
},
"name": {
"readOnly": true,
"example": "Account",
"type": "string"
},
"description": {
"readOnly": true,
"example": "Account level",
"type": "string"
}
},
"description": "System defined list of levels of sharing that can occur. Such as account level or invoice recipient level."
},
"UsageBucketSharePlan": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketSharePlan",
"readOnly": true,
"type": "number",
"example": 18
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 1,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"usageBucketShareLevelId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated UsageBucketShareLevel object."
},
"usageBucketShareLevelName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketShareLevelId property."
},
"name": {
"example": "Gold Plan Bucket",
"type": "string"
},
"description": {
"example": "100MB Inclusion",
"type": "string"
},
"usageBucketSharePlanActivationTypeId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated UsageBucketSharePlanActivationType object."
},
"usageBucketSharePlanActivationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketSharePlanActivationTypeId property."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"isAvailable": {
"type": "boolean",
"example": "true"
},
"defaultServiceStatusTypeId": {
"type": "number",
"example": 14,
"description": "Unique identifier for the associated ServiceStatusType object."
},
"defaultServiceStatusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the defaultServiceStatusTypeId property."
},
"isPackageLevelParticipation": {
"type": "boolean",
"example": "true"
},
"sharePlanTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated SharePlanType object."
},
"sharePlanTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the sharePlanTypeId property."
}
},
"description": "System defined list of levels of sharing that can occur. Such as account level or invoice recipient level."
},
"UsageBucketSharePlanActivationType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketSharePlanActivationType",
"readOnly": true,
"type": "number",
"example": 11
},
"name": {
"example": "Participating Service",
"type": "string"
},
"description": {
"example": "Participating Service",
"type": "string"
}
},
"description": "System defined list of sharing types that can occur. Such as selling or participating services."
},
"UsageBucketTier": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageBucketTier",
"readOnly": true,
"type": "number",
"example": 19
},
"usageBucketId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated UsageBucket object."
},
"usageBucketName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBucketId property."
},
"threshold": {
"type": "number",
"example": 14
},
"flatCharge": {
"type": "number",
"example": 12
},
"usageUnitId": {
"type": "number",
"example": 7,
"description": "Unique identifier for the associated UsageUnit object."
},
"usageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageUnitId property."
},
"packageFrequencyId": {
"type": "number",
"example": 15,
"description": "Unique identifier for the associated PackageFrequency object."
},
"packageFrequencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageFrequencyId property."
},
"packageServiceId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated PackageService object."
},
"packageServiceName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the packageServiceId property."
},
"currencyId": {
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Currency object."
},
"currencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyId property."
},
"money": {
"type": "number",
"example": 23
},
"priceBookId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated PriceBook object."
},
"priceBookName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the priceBookId property."
},
"tierCalculationTypeId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated TierCalculationType object."
},
"tierCalculationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the tierCalculationTypeId property."
},
"usageVolumeUsageClassId": {
"type": "number",
"example": 16,
"description": "Unique identifier for the associated UsageClass object."
},
"usageVolumeUsageClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageVolumeUsageClassId property."
},
"usageVolumeThreshold": {
"example": "Hello World",
"type": "string"
},
"usageVolumeUsageUnitId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated UsageUnit object."
},
"usageVolumeUsageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageVolumeUsageUnitId property."
}
},
"description": "Defines different tiers of pricing and inclusion for a Bucket."
},
"UsageClass": {
"type": "object",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 310
},
"trackingId": {
"type": [
"string",
"null"
],
"format": "uuid",
"example": "2d8bb6f9-6f08-4c1d-a7e9-4c9a8f5f1234"
},
"name": {
"type": "string",
"example": "Domestic Data"
},
"usageRaterTypeId": {
"type": "integer",
"example": 1
},
"usageRaterTypeName": {
"type": "string",
"example": "Static"
},
"usageBaseUnitId": {
"type": "integer",
"example": 5
},
"usageBaseUnitName": {
"type": "string",
"example": "Megabyte"
},
"usageClassTypeId": {
"type": [
"integer",
"null"
],
"example": 2
},
"usageClassTypeName": {
"type": [
"string",
"null"
],
"example": "Data"
},
"serviceTaxCategoryId": {
"type": [
"integer",
"null"
],
"example": 14
},
"serviceTaxCategoryName": {
"type": [
"string",
"null"
],
"example": "Telecom Data Services"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2025-03-13T16:22:00Z"
},
"createdByUserId": {
"type": "integer",
"example": 101
},
"createdByUserName": {
"type": "string",
"example": "api.admin"
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2025-10-01T11:45:00Z"
},
"updatedByUserId": {
"type": "integer",
"example": 101
},
"updatedByUserName": {
"type": "string",
"example": "api.admin"
},
"usageClassResolverTypeId": {
"type": "integer",
"example": 1
},
"usageClassResolverTypeName": {
"type": "string",
"example": "Static"
},
"details": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": null
}
},
"required": [
"identity",
"name",
"usageRaterTypeId",
"usageRaterTypeName",
"usageBaseUnitId",
"usageBaseUnitName",
"created",
"createdByUserId",
"createdByUserName",
"updated",
"updatedByUserId",
"updatedByUserName",
"usageClassResolverTypeId",
"usageClassResolverTypeName"
],
"description": "Usage class record that defines how a usage event is categorized and rated."
},
"BaseUnit": {
"type": "object",
"properties": {},
"required": []
},
"UsageClassDynamic": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageClassDynamic",
"readOnly": true,
"type": "number",
"example": 21
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 7,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "Roaming Voice",
"type": "string"
},
"description": {
"example": "Derrive if this record is in Roaming Voice.",
"type": "string"
},
"isActive": {
"type": "boolean",
"example": "true"
}
},
"description": "Defines a container of information on how to dynamically derive the Usage Class during mediation. It will have a set of associated rules."
},
"UsageClassDynamicRule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageClassDynamicRule",
"readOnly": true,
"type": "number",
"example": 21
},
"usageClassDynamicId": {
"type": "number",
"example": 3,
"description": "Unique identifier for the associated UsageClassDynamic object."
},
"usageClassDynamicName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassDynamicId property."
},
"extensionAttributeListItemId": {
"type": "number",
"example": 24,
"description": "A specified user defined Mediation field in the usage feed to be used as part of this rule. Unique identifier for the associated ExtensionAttributeListItem object."
},
"extensionAttributeListItemName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the extensionAttributeListItemId property."
},
"geoTreeLocationGroupId": {
"type": "number",
"example": 2,
"description": "Unique identifier for the associated GeoTreeLocationGroup object."
},
"geoTreeLocationGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationGroupId property."
},
"usageClassId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated UsageClass object."
},
"usageClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassId property."
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 5
}
},
"description": "Defines a rule used with a Dynamic Usage Class."
},
"UsageClassType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageClassType",
"readOnly": true,
"type": "number",
"example": 7
},
"name": {
"example": "Data Classes",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 18
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"updatedByUserId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {}
},
"description": "Defines a way of grouping all of your Usage Classes under a certain classification."
},
"UsageRate": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRate",
"readOnly": true,
"type": "number",
"example": 15
},
"usageRateGroupId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated UsageRateGroup object."
},
"usageRateGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageRateGroupId property."
},
"usageClassId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated UsageClass object."
},
"usageClassName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageClassId property."
},
"amount": {
"type": "number",
"example": 2.52
},
"geoTreeLocationId": {
"type": "number",
"example": 1,
"description": "Unique identifier for the associated GeoTreeLocation object."
},
"geoTreeLocationName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationId property."
},
"additional": {
"type": "boolean",
"example": "true"
},
"retired": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"usageRoundingId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageRounding object."
},
"usageRoundingName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageRoundingId property."
},
"displayName": {
"example": "My Rate",
"type": "string"
},
"geoTreeLocationGroupId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated GeoTreeLocationGroup object."
},
"geoTreeLocationGroupName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the geoTreeLocationGroupId property."
},
"minimumCharge": {
"type": "number",
"example": 5.34
},
"usageUnitId": {
"type": "number",
"example": 26,
"description": "Unique identifier for the associated UsageUnit object."
},
"usageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageUnitId property."
},
"usageRateCalculationTypeId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated UsageRateCalculationType object."
},
"usageRateCalculationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageRateCalculationTypeId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"generalLedgerId": {
"type": "number",
"example": 10,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"serviceTaxCategoryId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated ServiceTaxCategory object."
},
"serviceTaxCategoryName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the serviceTaxCategoryId property."
},
"createdByUserId": {
"type": "number",
"example": 8,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updatedByUserId": {
"type": "number",
"example": 21,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {}
},
"description": "Defines properties for an individual Usage Rate within the system."
},
"UsageRateCalculationType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRateCalculationType",
"readOnly": true,
"type": "number",
"example": 15
},
"name": {
"example": "Rated",
"type": "string"
},
"description": {
"example": "Rated",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 9
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "Defines a system list of different calculation types such as Rated, Fixed etc."
},
"UsageRateGroup": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRateGroup",
"readOnly": true,
"type": "number",
"example": 22
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 24,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "All Zone 2 Data Rates",
"type": "string"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The start date in which this group of rates come into effect. Date and time values are specified in the ISO 8601 format."
},
"end": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "System stamped time for when this group was retired. Date and time values are specified in the ISO 8601 format."
},
"useForCost": {
"type": "boolean",
"example": "true"
},
"timePeriodId": {
"type": "number",
"example": 25,
"description": "Unique identifier for the associated TimePeriod object."
},
"timePeriodName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the timePeriodId property."
},
"displayName": {
"example": "Gold Rates",
"type": "string"
},
"currencyId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated Currency object."
},
"currencyName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the currencyId property."
},
"isAggregated": {
"type": "boolean",
"example": "true"
},
"isPassThrough": {
"type": "boolean",
"example": "true"
},
"amountPrecision": {
"type": "number",
"example": 6
},
"roundingMethodTypeId": {
"type": "number",
"example": 17,
"description": "Unique identifier for the associated RoundingMethodType object."
},
"roundingMethodTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the roundingMethodTypeId property."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"generalLedgerId": {
"type": "number",
"example": 9,
"description": "Unique identifier for the associated GeneralLedger object."
},
"generalLedgerName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the generalLedgerId property."
},
"isTaxInclusive": {
"type": "boolean",
"example": "true"
},
"aggregationTypeId": {
"type": "number",
"example": 18,
"description": "Unique identifier for the associated AggregationType object."
},
"aggregationTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the aggregationTypeId property."
},
"createdByUserId": {
"type": "number",
"example": 22,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"updatedByUserId": {
"type": "number",
"example": 19,
"description": "Unique identifier for the associated User object."
},
"updatedByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the updatedByUserId property."
},
"isDeleted": {},
"deletedByUserId": {},
"deletedByUserName": {},
"isAggregatedByInvoicer": {
"type": "boolean",
"example": "true"
}
},
"description": "Defines a container that groups multiple rates together so that they can be reused in multiple plans."
},
"UsageRatePlan": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRatePlan",
"readOnly": true,
"type": "number",
"example": 3
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 22,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"name": {
"example": "All Data Rates",
"type": "string"
},
"displayName": {
"example": "Gold Rates",
"type": "string"
},
"isDeleted": {},
"updated": {
"description": "The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format.",
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"deletedByUserId": {}
},
"description": "Defines a container that holds multiple Rate Groups. These are assigned to Packages within the system."
},
"UsageRaterType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRaterType",
"readOnly": true,
"type": "number",
"example": 17
},
"name": {
"readOnly": true,
"example": "Class-Based",
"type": "string"
},
"description": {
"readOnly": true,
"example": "Class-Based",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 2
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
}
},
"description": "Defines a different system rating types such as location or class based rating."
},
"UsageRounding": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRounding",
"readOnly": true,
"type": "number",
"example": 21
},
"name": {
"example": "Round Up 6/60",
"type": "string"
},
"description": {
"example": "Round up in increments of 60",
"type": "string"
},
"minimum": {
"type": "number",
"example": 24
},
"increment": {
"type": "number",
"example": 1
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 25
},
"usageUnitId": {
"type": "number",
"example": 0,
"description": "Unique identifier for the associated UsageUnit object."
},
"usageUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageUnitId property."
},
"isActive": {
"type": "boolean",
"example": "true"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 14,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
}
},
"description": "Defines a Rounding Rule to be used with a Usage Rate."
},
"UsageUnit": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageUnit",
"readOnly": true,
"type": "number",
"example": 4
},
"usageBaseUnitId": {
"type": "number",
"example": 20,
"description": "Unique identifier for the associated UsageBaseUnit object."
},
"usageBaseUnitName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the usageBaseUnitId property."
},
"name": {
"readOnly": true,
"example": "Seconds",
"type": "string"
},
"description": {
"readOnly": true,
"example": "Seconds",
"type": "string"
},
"multiplierToBaseUnitType": {
"readOnly": true,
"example": "1024",
"type": "string"
},
"sortOrder": {
"readOnly": true,
"type": "number",
"example": 22
},
"visible": {
"readOnly": true,
"type": "boolean",
"example": "true"
},
"isBytesInBinaryUnit": {
"type": "boolean",
"example": "true"
}
},
"description": "Defines a system defined unit of measure based on time, data or counting such as seconds, minutes, hours, bytes, counts etc."
},
"UsageClassResolverType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageClassResolverType",
"readOnly": true,
"type": "number",
"example": 7
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"UsageIdentifier": {
"type": "object",
"properties": {}
},
"UsageRatedExceptionSchedule": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRatedExceptionSchedule",
"readOnly": true,
"type": "number",
"example": 17
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 2,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"scheduledStart": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The scheduled start date and time. Date and time values are specified in the ISO 8601 format."
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The actual start date and time. Date and time values are specified in the ISO 8601 format."
},
"complete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "The completion date and time. Date and time values are specified in the ISO 8601 format."
},
"created": {
"readOnly": true,
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z",
"description": "This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format."
},
"createdByUserId": {
"type": "number",
"example": 6,
"description": "Unique identifier for the associated User object."
},
"createdByUserName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the createdByUserId property."
},
"filterCriteria": {
"example": "Hello World",
"type": "string"
},
"sentCount": {
"example": "Hello World",
"type": "string"
},
"isDelete": {
"type": "boolean",
"example": "true"
}
},
"description": "Details the schedules of usage rated exception reprocessing."
},
"UsageRatedExceptionType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UsageRatedExceptionType",
"readOnly": true,
"type": "number",
"example": 8
},
"sortOrder": {
"type": "number",
"example": 5
},
"description": {
"example": "Unable to find or apply rate for the record",
"type": "string"
},
"name": {
"example": "Rate Not Found",
"type": "string"
}
},
"description": "Details the types of usage rated exception."
},
"AdministrationUser": {
"type": "object",
"properties": {},
"description": ""
},
"UserStatusType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the UserStatusType",
"readOnly": true,
"type": "number",
"example": 15
},
"name": {
"example": "Active",
"type": "string"
},
"ownerId": {
"readOnly": true,
"type": "number",
"example": 6,
"description": "Unique identifier for the associated Owner object."
},
"ownerName": {
"readOnly": true,
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the ownerId property."
},
"statusTypeId": {
"type": "number",
"example": 12,
"description": "Unique identifier for the associated StatusType object."
},
"statusTypeName": {
"example": "Sample Name",
"type": "string",
"description": "The name of the object associated with the statusTypeId property."
}
},
"description": "Defines a list of status types for a user in the system. These are user defined statuses that then point to a system status for meaning."
},
"AccountServiceUsageBucketConsumption": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"example": 1
},
"pageSize": {
"type": "integer",
"example": 20
},
"excludeTotalCount": {
"type": "boolean",
"example": false
}
},
"required": [
"pageNumber",
"pageSize",
"excludeTotalCount"
]
},
"pagedResults": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountServiceUsageBucketId": {
"type": "integer",
"example": 6
},
"accountId": {
"type": "integer",
"example": 10000003
},
"accountPackageId": {
"type": "integer",
"example": 3176
},
"accountServiceId": {
"type": "integer",
"example": 20121
},
"accountServiceName": {
"type": "string",
"example": "A service non Ex"
},
"bucketId": {
"type": "integer",
"example": 6
},
"catalogBucketId": {
"type": "integer",
"example": 1306
},
"bucketName": {
"type": "string",
"example": "A Simple Bucket"
},
"bucketSize": {
"type": "number",
"example": 500
},
"usageConsumed": {
"type": "number",
"example": 500
},
"udrUsageIdentifier": {
"type": "string",
"example": "CCCC"
},
"isProrated": {
"type": "boolean",
"example": false
},
"isLastTierRepeating": {
"type": "boolean",
"example": false
},
"refillTypeId": {
"type": "integer",
"example": 7
},
"refillTypeName": {
"type": "string",
"example": "Nonrecurring"
},
"expireAfterFrequency": {
"type": "integer",
"example": 2
},
"expireAfterFrequencyTypeId": {
"type": "integer",
"example": 3
},
"expireAfterFrequencyTypeName": {
"type": "string",
"example": "Month"
},
"isSharedAcrossPackage": {
"type": "boolean",
"example": false
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"example": "2021-07-23T21:30:05Z"
},
"effectiveCancelDate": {
"type": "string",
"format": "date-time",
"example": "2021-09-23T21:30:05Z"
},
"expiryDate": {
"type": "string",
"format": "date-time",
"example": "2021-09-23T21:30:05Z"
},
"startDate": {
"type": "string",
"format": "date-time",
"example": "2021-07-23T21:30:05Z"
},
"endDate": {
"type": "string",
"format": "date-time",
"example": "2021-09-23T21:30:05Z"
},
"usageUnitId": {
"type": "integer",
"example": 5
},
"usageUnitName": {
"type": "string",
"example": "B"
},
"details": {
"type": "object",
"properties": {
"viewAccountServiceUsageBucketConsumption": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udrUsageBucketId": {
"type": "integer",
"example": 5
},
"accountServiceUsageBucketId": {
"type": "integer",
"example": 6
},
"accountServiceUsageBucketTierId": {
"type": "integer",
"example": 9
},
"catalogBucketTierId": {
"type": "integer",
"example": 1289
},
"thresholdFrom": {
"type": "number",
"example": 0
},
"thresholdTo": {
"type": "number",
"example": 250
},
"usageConsumed": {
"type": "number",
"example": 250
},
"usageUnitId": {
"type": "integer",
"example": 5
},
"usageUnitName": {
"type": "string",
"example": "B"
},
"startDate": {
"type": "string",
"format": "date-time",
"example": "2021-07-23T21:30:05Z"
},
"endDate": {
"type": "string",
"format": "date-time",
"example": "2021-09-23T21:30:05Z"
}
},
"required": [
"udrUsageBucketId",
"accountServiceUsageBucketId",
"accountServiceUsageBucketTierId",
"catalogBucketTierId",
"thresholdFrom",
"thresholdTo",
"usageConsumed",
"usageUnitId",
"usageUnitName",
"startDate",
"endDate"
]
}
}
},
"required": [
"totalCount",
"items"
]
},
"usageBucketBase": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 20100
},
"name": {
"type": "string",
"example": "Data - USA"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2018-10-17T00:00:00Z"
},
"retired": {
"type": "boolean",
"example": false
},
"usageBucketBaseUnitId": {
"type": "integer",
"example": 2
},
"usageBucketBaseUnitName": {
"type": "string",
"example": "Data"
}
},
"required": [
"identity",
"name",
"start",
"retired",
"usageBucketBaseUnitId",
"usageBucketBaseUnitName"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"viewAccountServiceUsageBucketConsumption",
"usageBucketBase"
]
}
},
"required": [
"accountServiceUsageBucketId",
"accountId",
"accountPackageId",
"accountServiceId",
"accountServiceName",
"bucketId",
"catalogBucketId",
"bucketName",
"bucketSize",
"usageConsumed",
"udrUsageIdentifier",
"isProrated",
"isLastTierRepeating",
"refillTypeId",
"refillTypeName",
"expireAfterFrequency",
"expireAfterFrequencyTypeId",
"expireAfterFrequencyTypeName",
"isSharedAcrossPackage",
"effectiveDate",
"effectiveCancelDate",
"expiryDate",
"startDate",
"endDate",
"usageUnitId",
"usageUnitName",
"details"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"pagination",
"pagedResults"
]
},
"DataImportHistory": {
"type": "object",
"properties": {},
"description": "This allows for querying any of the import exceptions that may have occured."
},
"Exception": {
"type": "object",
"properties": {},
"required": []
},
"WebhookCallback": {
"type": "object",
"properties": {}
},
"WebhookFormatType": {
"type": "object",
"properties": {
"identity": {
"description": "This is the unique numeric identifier for the WebhookFormatType",
"readOnly": true,
"type": "number",
"example": 12
},
"name": {
"example": "Hello World",
"type": "string"
}
}
},
"SimulatePackageBillingParam": {
"type": "object",
"properties": {
"accountName": {
"type": "string",
"example": "Demo Simulation"
},
"accountPackagesToCancel": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountPackageId": {
"type": "string",
"example": "3"
},
"billCancelOptionTypeId": {
"type": "string",
"example": "1"
}
},
"required": [
"accountPackageId",
"billCancelOptionTypeId"
]
}
},
"asOfDate": {
"type": "string",
"format": "date",
"example": "2025-12-01"
},
"catalogPackagesToAdd": {
"type": "array",
"items": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"example": "Advanced Annual Plan"
},
"packageFrequencyName": {
"type": "string",
"example": "Annual"
},
"priceBookName": {
"type": "string",
"example": "Standard Price Book"
}
},
"required": [
"packageName",
"packageFrequencyName",
"priceBookName"
]
}
}
},
"required": [
"accountName",
"asOfDate"
]
},
"SimulatePackageBillingResult": {
"type": "object",
"properties": {
"totalInvoiceAmount": {
"type": "number",
"example": 474.02
},
"currencyCode": {
"type": "string",
"example": "USD"
},
"currencyName": {
"type": "string",
"example": "United States Dollar"
},
"invoiceItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"example": "Connext Package"
},
"packageFrequencyName": {
"type": "string",
"example": "Annual"
},
"serviceName": {
"type": "string",
"example": "ConnextService"
},
"periodStartDate": {
"type": "string",
"format": "date",
"example": "2025-09-26"
},
"periodEndDate": {
"type": "string",
"format": "date",
"example": "2026-09-25"
},
"invoiceAmount": {
"type": "number",
"example": 500
},
"invoiceItemTypeName": {
"type": "string",
"example": "Recurring Charge"
}
},
"required": [
"packageName",
"packageFrequencyName",
"serviceName",
"periodStartDate",
"periodEndDate",
"invoiceAmount",
"invoiceItemTypeName"
]
}
}
},
"required": [
"totalInvoiceAmount",
"currencyCode",
"currencyName",
"invoiceItems"
]
},
"ContractEarlyTerminationParam": {
"type": "object",
"properties": {
"earlyTermination": {
"type": "string",
"format": "date-time",
"example": "2025-10-25T18:01:57.7651088Z"
},
"earlyTerminationComment": {
"type": "string",
"example": "Customer moved out of country"
},
"terminationAccountContractStatusTypeId": {
"type": "integer",
"example": 5
}
},
"required": [
"earlyTermination",
"terminationAccountContractStatusTypeId"
]
},
"ContractEarlyTerminationResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "d2ae5304-2355-44eb-a328-272f02935f8b"
},
"type": {
"type": "string",
"example": "update"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"earlyTermination": {
"type": "string",
"format": "date-time",
"example": "2025-10-25T18:01:57.7651088Z"
},
"earlyTerminationComment": {
"type": "string",
"example": "Customer moved out of country"
},
"terminationAccountContractStatusTypeId": {
"type": "integer",
"example": 5
}
},
"required": [
"earlyTermination",
"terminationAccountContractStatusTypeId"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"AccountPricePlanActiveForAccountDetail": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "106ab566-c0fd-46ed-8932-4365208cd0e3"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 2
},
"name": {
"type": "string",
"example": "Fall 2018"
},
"accountId": {
"type": "integer",
"example": 10000000
},
"accountName": {
"type": "string",
"example": "Anthem Records"
},
"description": {
"type": "string",
"example": "Autumn Special"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2018-10-01T00:00:00"
},
"isConsolidatedByInvoicer": {
"type": "boolean",
"example": true
},
"details": {
"type": "object",
"properties": {
"pricePlans": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 1500
},
"packageServiceId": {
"type": "integer",
"example": 3
},
"packageFrequencyId": {
"type": "integer",
"example": 44
},
"packageFrequencyName": {
"type": "string",
"example": "DialUp Package - 1 Month"
},
"packageCurrencyId": {
"type": "integer",
"example": 2
},
"accountPricePlanId": {
"type": "integer",
"example": 2
},
"accountPricePlanName": {
"type": "string",
"example": "Fall 2018"
},
"isCountOnFirstUsage": {
"type": "boolean",
"example": false
},
"packageId": {
"type": "integer",
"example": 2
},
"packageName": {
"type": "string",
"example": "DialUp Package"
},
"serviceId": {
"type": "integer",
"example": 2
},
"serviceName": {
"type": "string",
"example": "Dialup Service"
},
"packageFrequencyPackageCurrencyIsActive": {
"type": "boolean",
"example": true
},
"currencyId": {
"type": "integer",
"example": 1
},
"currencyName": {
"type": "string",
"example": "United States Dollar"
},
"currencyCode": {
"type": "string",
"example": "USD"
},
"statusTierTypeId": {
"type": "integer",
"example": 2
},
"statusTierTypeName": {
"type": "string",
"example": "Tier By Status"
},
"details": {
"type": "object",
"properties": {
"recurringPrices": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 203
},
"packageServicePricePlanId": {
"type": "integer",
"example": 1500
},
"serviceStatusTypeId": {
"type": "integer",
"example": 12
},
"serviceStatusTypeName": {
"type": "string",
"example": "Active"
},
"pricePlanTierTypeId": {
"type": "integer",
"example": 1
},
"pricePlanTierTypeName": {
"type": "string",
"example": "Tiered - Bracket Pricing"
},
"details": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 121
},
"amount": {
"type": "number",
"example": 2.9
},
"threshold": {
"type": "integer",
"example": 10
},
"packageServiceRecurringPriceId": {
"type": "integer",
"example": 203
}
},
"required": [
"identity",
"amount",
"packageServiceRecurringPriceId"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"identity",
"packageServicePricePlanId",
"serviceStatusTypeId",
"serviceStatusTypeName",
"pricePlanTierTypeId",
"pricePlanTierTypeName",
"details"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"recurringPrices"
]
}
},
"required": [
"identity",
"packageServiceId",
"packageFrequencyId",
"packageFrequencyName",
"packageCurrencyId",
"accountPricePlanId",
"accountPricePlanName",
"isCountOnFirstUsage",
"packageId",
"packageName",
"serviceId",
"serviceName",
"packageFrequencyPackageCurrencyIsActive",
"currencyId",
"currencyName",
"currencyCode",
"statusTierTypeId",
"statusTierTypeName",
"details"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"pricePlans"
]
}
},
"required": [
"identity",
"name",
"accountId",
"accountName",
"description",
"start",
"isConsolidatedByInvoicer",
"details"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"AccountPricePlanActiveForAccount": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "b9e5eb9f-e754-4f29-88aa-993687632ee1"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 2
},
"name": {
"type": "string",
"example": "Fall 2018"
},
"accountId": {
"type": "integer",
"example": 10000000
},
"accountName": {
"type": "string",
"example": "Anthem Records"
},
"description": {
"type": "string",
"example": "Autumn Special"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2018-10-01T00:00:00"
},
"isConsolidatedByInvoicer": {
"type": "boolean",
"example": true
}
},
"required": [
"identity",
"name",
"accountId",
"accountName",
"description",
"start",
"isConsolidatedByInvoicer"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"AccountServiceUsageIdentifier": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "c50906bc-492b-4c87-9b83-eec9dd887aa8"
},
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"example": 196
},
"accountName": {
"type": "string",
"example": "mlongo"
},
"accountPackageId": {
"type": "integer",
"example": 3173
},
"accountPackageName": {
"type": "string",
"example": "Share Plan 1 Package"
},
"accountServiceId": {
"type": "integer",
"example": 20118
},
"accountServiceName": {
"type": "string",
"example": "Contributing Service 1 - 10 SMS"
},
"udrUsageIdentifier": {
"type": "string",
"example": "4445551444"
},
"serviceStatusTypeId": {
"type": "integer",
"example": 12
},
"serviceStatusTypeName": {
"type": "string",
"example": "Active"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2020-02-16T20:48:00Z"
},
"end": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
}
},
"required": [
"accountId",
"accountName",
"accountPackageId",
"accountPackageName",
"accountServiceId",
"accountServiceName",
"udrUsageIdentifier",
"serviceStatusTypeId",
"serviceStatusTypeName",
"start",
"end"
]
}
}
},
"required": [
"trackingId",
"totalCount",
"items"
]
},
"AccountSharePlanAddOnResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "d090d5a4-8b75-4068-a43c-f3b79fae5de9"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 7
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 3177
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "accountPackage"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 3177
},
"accountId": {
"type": "integer",
"example": 10000003
},
"accountName": {
"type": "string",
"example": "Dan Steele"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-06-23T18:36:48.073Z"
},
"nextBill": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"name": {
"type": "string",
"example": "Share Plan Add On Package"
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2023-01-01T00:00:00Z"
},
"packageFrequencyId": {
"type": "integer",
"example": 1147
},
"packageFrequencyName": {
"type": "string",
"example": "Share Plan Add On Package Frequency"
},
"createdByUserId": {
"type": "integer",
"example": 8000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"accountSharePlanId": {
"type": "integer",
"example": 2
},
"packageCategoryId": {
"type": "integer",
"example": 4
},
"packageCategoryName": {
"type": "string",
"example": "Share Plan Add-on"
},
"chargeRecurringIfUsage": {
"type": "boolean",
"example": false
},
"waiveEarlyTerminationFee": {
"type": "boolean",
"example": false
},
"quantity": {
"type": "integer",
"example": 1
},
"isQuantityAllowed": {
"type": "boolean",
"example": false
},
"priceBookId": {
"type": "integer",
"example": 1
},
"priceBookName": {
"type": "string",
"example": "Standard Price Book"
},
"serviceId": {
"type": "integer",
"example": 1196
},
"serviceName": {
"type": "string",
"example": "Share Plan Add On Service"
},
"accountPackageId": {
"type": "integer",
"example": 3177
},
"accountPackageName": {
"type": "string",
"example": "Share Plan Add On Package"
},
"usageNextBill": {
"type": "string",
"format": "date-time",
"example": "2023-02-01T00:00:00Z"
},
"isTaxInclusive": {
"type": "boolean",
"example": false
},
"usageBucketId": {
"type": "integer",
"example": 1
},
"usageBucketName": {
"type": "string",
"example": "Internet Data"
},
"refillFrequency": {
"type": "integer",
"example": 3
},
"refillFrequencyTypeId": {
"type": "integer",
"example": 3
},
"refillFrequencyTypeName": {
"type": "string",
"example": "Month"
},
"prorate": {
"type": "boolean",
"example": true
},
"isInfiniteLastTier": {
"type": "boolean",
"example": false
},
"isThresholdPerAccountService": {
"type": "boolean",
"example": false
},
"usageBucketRefillTypeId": {
"type": "integer",
"example": 6
},
"usageBucketRefillTypeName": {
"type": "string",
"example": "Recurring with rollover"
},
"expireAfterRecurrence": {
"type": "integer",
"example": 5
},
"accountPackageActivation": {
"type": "boolean",
"example": false
},
"isSharedAcrossPackage": {
"type": "boolean",
"example": false
},
"overageUsageRatePlanId": {
"type": [
"integer",
"null"
],
"example": null
},
"overageUsageRatePlanName": {
"type": [
"string",
"null"
],
"example": null
},
"accountServiceUsageBucketId": {
"type": "integer",
"example": 9
},
"threshold": {
"type": "number",
"example": 500
},
"flatCharge": {
"type": "number",
"example": 0
},
"usageUnitId": {
"type": "integer",
"example": 8
},
"usageUnitName": {
"type": "string",
"example": "GB"
},
"serviceStatusTypeId": {
"type": "integer",
"example": 12
},
"serviceStatusTypeName": {
"type": "string",
"example": "Active"
},
"packageServicePricePlanId": {
"type": "integer",
"example": 3074
},
"amount": {
"type": "number",
"example": 999
},
"pricePlanTierTypeId": {
"type": "integer",
"example": 2
},
"pricePlanTierTypeName": {
"type": "string",
"example": "Not Tiered"
},
"accountPackageStatusTypeId": {
"type": "integer",
"example": 99
},
"accountPackageStatusTypeName": {
"type": "string",
"example": "Active"
}
},
"additionalProperties": false
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"AccountSharePlanAddOnParam": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"example": "Share Plan Add On Package"
},
"packageFrequencyName": {
"type": "string",
"example": "Share Plan Add On Package Frequency"
},
"effective": {
"type": "string",
"format": "date",
"example": "2023-01-01"
},
"recurringPriceOverride": {
"type": "object",
"properties": {
"instance": {
"type": "object",
"properties": {
"serviceName": {
"type": "string",
"example": "Share Plan Add On Service"
},
"amount": {
"type": "number",
"example": 999
}
},
"required": [
"serviceName",
"amount"
]
}
},
"required": [
"instance"
]
}
},
"required": [
"packageName",
"packageFrequencyName",
"effective",
"recurringPriceOverride"
]
},
"AccountSharePlanForAccountRankParam": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
13,
20,
12,
41
]
},
"ApplicationVersionResults": {
"type": "object",
"properties": {
"applicationVersion": {
"type": "string",
"example": "10.6.0.0+1224"
}
},
"required": [
"applicationVersion"
]
},
"BillRunScheduleOneTimeResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "1ea52c52-82f9-4566-82d2-20255bacaa9a"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "billRunSchedule"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"created": {
"type": "string",
"format": "date-time",
"example": "2022-04-20T13:45:47.423Z"
},
"billRunScheduleStatusTypeId": {
"type": "integer",
"example": 1
},
"billRunScheduleStatusTypeName": {
"type": "string",
"example": "Scheduled"
},
"accountId": {
"type": "integer",
"example": 153
},
"accountName": {
"type": "string",
"example": "admin"
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2022-06-01T00:00:00Z"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2022-06-30T00:00:00Z"
},
"createdByUserId": {
"type": "integer",
"example": 153
},
"createdByUserName": {
"type": "string",
"example": "admin"
},
"billRunSettings": {
"type": "string",
"example": "{ \"runBillUsage\": true, \"runBilling\": true }"
}
},
"required": [
"identity",
"created",
"billRunScheduleStatusTypeId",
"billRunScheduleStatusTypeName",
"accountId",
"accountName",
"periodStart",
"periodEnd",
"createdByUserId",
"createdByUserName",
"billRunSettings"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"BillRunScheduleOneTimeParam": {
"type": "object",
"properties": {
"collectionTypeId": {
"type": "integer",
"example": 2
},
"currencyExchangeId": {
"type": [
"integer",
"null"
],
"example": null
},
"accountId": {
"type": "integer",
"example": 153
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2022-06-01T00:00:00"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2022-06-30T00:00:00"
},
"postingDate": {
"type": "string",
"format": "date-time",
"example": "2022-04-20T00:00:00"
},
"runBilling": {
"type": "boolean",
"example": true
},
"runBillUsage": {
"type": "boolean",
"example": true
},
"runDelivery": {
"type": "boolean",
"example": false
},
"runContract": {
"type": "boolean",
"example": false
},
"runPayment": {
"type": "boolean",
"example": false
},
"runPaymentTerm": {
"type": "boolean",
"example": false
},
"runRenderInvoice": {
"type": "boolean",
"example": true
},
"runInvoicing": {
"type": "boolean",
"example": true
}
},
"required": [
"collectionTypeId",
"accountId",
"periodStart",
"periodEnd",
"postingDate",
"runBilling",
"runBillUsage",
"runDelivery",
"runContract",
"runPayment",
"runPaymentTerm",
"runRenderInvoice",
"runInvoicing"
]
},
"CustomDataSourcePagedResult": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"example": 1
},
"pageSize": {
"type": "integer",
"example": 5000
},
"excludeTotalCount": {
"type": "boolean",
"example": false
}
},
"required": [
"pageNumber",
"pageSize",
"excludeTotalCount"
]
},
"pagedResults": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 3
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"example": 10000000
},
"accountName": {
"type": "string",
"example": "Anthem Records"
},
"parentAccountId": {
"type": "integer",
"example": 10000000
},
"parentAccountName": {
"type": "string",
"example": "Anthem Records"
},
"topAccountId": {
"type": "integer",
"example": 10000000
},
"topAccountName": {
"type": "string",
"example": "Anthem Records"
}
},
"required": [
"accountId",
"accountName",
"parentAccountId",
"parentAccountName",
"topAccountId",
"topAccountName"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"pagination",
"pagedResults"
]
},
"DataExportHistoryDownload": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "d2ae5304-2355-44eb-a328-272f02935f8b"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 1
},
"dataExportId": {
"type": "integer",
"example": 10
},
"dataExportName": {
"type": "string",
"example": "Sample Text Data"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"complete": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"dataExportHistoryStatusTypeId": {
"type": "integer",
"example": 3
},
"dataExportHistoryStatusTypeName": {
"type": "string",
"example": "Sample Text Data"
},
"storageLocationId": {
"type": "integer",
"example": 18
},
"storageLocationName": {
"type": "string",
"example": "Sample Text Data"
},
"storageKey": {
"type": "string",
"example": "Sample Text Data"
},
"exportRowCount": {
"type": "integer",
"example": 21
},
"createdByUserId": {
"type": "integer",
"example": 3
},
"createdByUserName": {
"type": "string",
"example": "Sample Text Data"
},
"parameters": {
"type": "string",
"example": "Sample Text Data"
},
"transferLocationId": {
"type": "integer",
"example": 27
},
"transferLocationName": {
"type": "string",
"example": "Sample Text Data"
},
"fileMoveLogIdentity": {
"type": "integer",
"example": 27
},
"link": {
"type": "string",
"format": "uri",
"example": "https://mydomain.com/exports/history/12345.csv?token=example",
"description": "Direct link to download the generated export file."
}
},
"required": [
"identity",
"dataExportId",
"dataExportName",
"created",
"start",
"complete",
"dataExportHistoryStatusTypeId",
"dataExportHistoryStatusTypeName",
"storageLocationId",
"storageLocationName",
"storageKey",
"exportRowCount",
"createdByUserId",
"createdByUserName",
"parameters",
"transferLocationId",
"transferLocationName",
"fileMoveLogIdentity",
"link"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"DataImportUsageIdResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "43fa3978-c1cc-4a48-afaa-5e1f9955d5ab"
},
"type": {
"type": "string",
"example": "sendMessage"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "messageSent"
},
"dtoTypeKey": {
"type": "string",
"example": "dataImportUsageResults"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 100
},
"successful": {
"type": "boolean",
"example": true
}
},
"required": [
"identity",
"successful"
]
}
},
"required": [
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"DataImportUsageIdParam": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "106ab566-c0fd-46ed-8932-4365208cd0e3"
},
"example": [
"106ab566-c0fd-46ed-8932-4365208cd0e3",
"106ab566-c0fd-46ed-8932-4365208cd0e3",
"106ab566-c0fd-46ed-8932-4365208cd0e3"
]
}
},
"required": [
"data"
]
},
"DataImportUsageJsonIdResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "b4701009-121f-4903-a33d-c0039b33a512"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "dataImportRequestTracking"
},
"instance": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "0e6042bb-ccbe-41d9-b471-69c988c990ab"
},
"udrFeedId": {
"type": "integer",
"example": 3
}
},
"required": [
"trackingId",
"udrFeedId"
]
}
},
"required": [
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"DataImportUsageJsonIdParam": {
"type": "object",
"properties": {
"DateTime": {
"type": "string",
"format": "date-time",
"example": "2023-04-25T01:01:00.06"
},
"UdrIdentifierTypeName": {
"type": "string",
"example": "Unknown"
},
"OriginatingIdentifier": {
"type": "string",
"example": "111222333444555"
},
"TerminatingIdentifier": {
"type": "string",
"example": "987-654-321"
},
"UdrUsageIdentifier": {
"type": "string",
"example": "123-456-789"
},
"Value": {
"type": "number",
"example": 134
},
"Inbound": {
"type": "boolean",
"example": false
},
"ReverseRating": {
"type": "boolean",
"example": false
},
"UsageClassName": {
"type": "string",
"example": "data_class"
},
"UsageClassTypeName": {
"type": "string",
"example": "data_classType"
}
},
"required": [
"DateTime",
"UdrIdentifierTypeName",
"OriginatingIdentifier",
"TerminatingIdentifier",
"UdrUsageIdentifier",
"Value",
"Inbound",
"ReverseRating",
"UsageClassName",
"UsageClassTypeName"
]
},
"DataImportUsageJsonMuliIdResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "78578940-e75f-4984-9db3-75fdf552913d"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "dataImportRequestTracking"
},
"instance": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "a654294f-9fd6-4576-aeec-b4531b742dd1"
},
"udrFeedId": {
"type": "integer",
"example": 3
}
},
"required": [
"trackingId",
"udrFeedId"
]
}
},
"required": [
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"DataImportUsageJsonMultiIdParam": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DateTime": {
"type": "string",
"format": "date-time",
"example": "2023-04-25T01:01:00.06"
},
"UdrIdentifierTypeName": {
"type": "string",
"example": "Unknown"
},
"OriginatingIdentifier": {
"type": "string",
"example": "987654321"
},
"TerminatingIdentifier": {
"type": "string",
"example": "123456789"
},
"UdrUsageIdentifier": {
"type": "string",
"example": "814-241-4332"
},
"Value": {
"type": "number",
"example": 134
},
"Inbound": {
"type": "boolean",
"example": false
},
"ReverseRating": {
"type": "boolean",
"example": false
},
"UsageClassName": {
"type": "string",
"example": "data_class"
},
"UsageClassTypeName": {
"type": "string",
"example": "data_classType"
}
},
"required": [
"DateTime",
"UdrIdentifierTypeName",
"OriginatingIdentifier",
"TerminatingIdentifier",
"UdrUsageIdentifier",
"Value",
"Inbound",
"ReverseRating",
"UsageClassName",
"UsageClassTypeName"
]
},
"example": [
{
"DateTime": "2023-04-25T01:01:00.06",
"UdrIdentifierTypeName": "Unknown",
"OriginatingIdentifier": "4038675310",
"TerminatingIdentifier": "4038675346",
"UdrUsageIdentifier": "814-241-4332",
"Value": 134,
"Inbound": false,
"ReverseRating": false,
"UsageClassName": "data_class",
"UsageClassTypeName": "data_classType"
}
]
}
},
"required": [
"data"
]
},
"DataImportHistoryExceptionPagedResult": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"example": 1
},
"pageSize": {
"type": "integer",
"example": 20
},
"excludeTotalCount": {
"type": "boolean",
"example": false
}
},
"required": [
"pageNumber",
"pageSize",
"excludeTotalCount"
]
},
"pagedResults": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataImportExceptionId": {
"type": "integer",
"example": 1
},
"importBatchId": {
"type": "integer",
"example": 31
},
"dataImportExceptionErrorTypeId": {
"type": "integer",
"example": 8
},
"dataImportExceptionErrorTypeName": {
"type": "string",
"example": "Unknown Error"
},
"dataImportExceptionStatusTypeId": {
"type": "integer",
"example": 1
},
"dataImportExceptionStatusTypeName": {
"type": "string",
"example": "New"
},
"originatingFileRecordIndex": {
"type": "integer",
"example": 1
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32.55Z"
},
"dataImportHistoryId": {
"type": "integer",
"example": 1
},
"dataImportExceptionDataRevisionId": {
"type": "integer",
"example": 9
},
"revisionNumber": {
"type": "integer",
"example": 1
},
"dataSnippet": {
"type": "string",
"example": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory"
},
"exceptionDate": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32Z"
},
"message": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"messageDetails": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"fileName": {
"type": "string",
"example": "Usage Class Import Sample - Sheet1.csv"
},
"importBatchTypeId": {
"type": "integer",
"example": 3
},
"importBatchTypeName": {
"type": "string",
"example": "Non-Usage By File"
}
},
"required": [
"dataImportExceptionId",
"importBatchId",
"dataImportExceptionErrorTypeId",
"dataImportExceptionErrorTypeName",
"dataImportExceptionStatusTypeId",
"dataImportExceptionStatusTypeName",
"originatingFileRecordIndex",
"created",
"dataImportHistoryId",
"dataImportExceptionDataRevisionId",
"revisionNumber",
"dataSnippet",
"exceptionDate",
"message",
"messageDetails",
"fileName",
"importBatchTypeId",
"importBatchTypeName"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"pagination",
"pagedResults"
]
},
"DataImportHistoryIDExceptionResult": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataImportExceptionId": {
"type": "integer",
"example": 1
},
"importBatchId": {
"type": "integer",
"example": 31
},
"dataImportExceptionErrorTypeId": {
"type": "integer",
"example": 8
},
"dataImportExceptionErrorTypeName": {
"type": "string",
"example": "Unknown Error"
},
"dataImportExceptionStatusTypeId": {
"type": "integer",
"example": 1
},
"dataImportExceptionStatusTypeName": {
"type": "string",
"example": "New"
},
"originatingFileRecordIndex": {
"type": "integer",
"example": 1
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32.55Z"
},
"dataImportHistoryId": {
"type": "integer",
"example": 1
},
"dataImportExceptionDataRevisionId": {
"type": "integer",
"example": 9
},
"revisionNumber": {
"type": "integer",
"example": 1
},
"dataSnippet": {
"type": "string",
"example": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory"
},
"exceptionDate": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32Z"
},
"message": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"messageDetails": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"fileName": {
"type": "string",
"example": "Usage Class Import Sample - Sheet1.csv"
},
"importBatchTypeId": {
"type": "integer",
"example": 3
},
"importBatchTypeName": {
"type": "string",
"example": "Non-Usage By File"
}
},
"required": [
"dataImportExceptionId",
"importBatchId",
"dataImportExceptionErrorTypeId",
"dataImportExceptionErrorTypeName",
"dataImportExceptionStatusTypeId",
"dataImportExceptionStatusTypeName",
"originatingFileRecordIndex",
"created",
"dataImportHistoryId",
"dataImportExceptionDataRevisionId",
"revisionNumber",
"dataSnippet",
"exceptionDate",
"message",
"messageDetails",
"fileName",
"importBatchTypeId",
"importBatchTypeName"
]
}
}
},
"required": [
"totalCount",
"items"
]
},
"DataImportHistoryIDExceptionPagedResult": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"example": 1
},
"pageSize": {
"type": "integer",
"example": 20
},
"excludeTotalCount": {
"type": "boolean",
"example": false
}
},
"required": [
"pageNumber",
"pageSize",
"excludeTotalCount"
]
},
"pagedResults": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataImportExceptionId": {
"type": "integer",
"example": 1
},
"importBatchId": {
"type": "integer",
"example": 31
},
"dataImportExceptionErrorTypeId": {
"type": "integer",
"example": 8
},
"dataImportExceptionErrorTypeName": {
"type": "string",
"example": "Unknown Error"
},
"dataImportExceptionStatusTypeId": {
"type": "integer",
"example": 1
},
"dataImportExceptionStatusTypeName": {
"type": "string",
"example": "New"
},
"originatingFileRecordIndex": {
"type": "integer",
"example": 1
},
"created": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32.55Z"
},
"dataImportHistoryId": {
"type": "integer",
"example": 1
},
"dataImportExceptionDataRevisionId": {
"type": "integer",
"example": 9
},
"revisionNumber": {
"type": "integer",
"example": 1
},
"dataSnippet": {
"type": "string",
"example": "UsageClassName,RaterType,BaseUnit,UsageClassTypeName,ServiceTaxCategory"
},
"exceptionDate": {
"type": "string",
"format": "date-time",
"example": "2023-05-19T12:55:32Z"
},
"message": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"messageDetails": {
"type": "string",
"example": "Could not find a match for UsageRaterTypeName with value 'RaterType'."
},
"fileName": {
"type": "string",
"example": "Usage Class Import Sample - Sheet1.csv"
},
"importBatchTypeId": {
"type": "integer",
"example": 3
},
"importBatchTypeName": {
"type": "string",
"example": "Non-Usage By File"
}
},
"required": [
"dataImportExceptionId",
"importBatchId",
"dataImportExceptionErrorTypeId",
"dataImportExceptionErrorTypeName",
"dataImportExceptionStatusTypeId",
"dataImportExceptionStatusTypeName",
"originatingFileRecordIndex",
"created",
"dataImportHistoryId",
"dataImportExceptionDataRevisionId",
"revisionNumber",
"dataSnippet",
"exceptionDate",
"message",
"messageDetails",
"fileName",
"importBatchTypeId",
"importBatchTypeName"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"pagination",
"pagedResults"
]
},
"InvoiceItemCreditResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "53064b3f-a018-4dd2-96a1-793e07e4e3a6"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 6
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 11
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "invoiceItem"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 11
},
"accountId": {
"type": "integer",
"example": 153
},
"accountName": {
"type": "string",
"example": "admin"
},
"serviceId": {
"type": "integer",
"example": 1
},
"serviceName": {
"type": "string",
"example": "Extreme DSL Service"
},
"amount": {
"type": "number",
"example": -10
},
"detail": {
"type": "string",
"example": "ACME Co"
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2019-08-13T00:00:00"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2019-08-13T00:00:00"
},
"credit": {
"type": "boolean",
"example": true
},
"date": {
"type": "string",
"format": "date-time",
"example": "2019-08-13T00:00:00"
},
"posting": {
"type": "string",
"format": "date-time",
"example": "2019-08-13T00:00:00"
},
"bulkQuantity": {
"type": "integer",
"example": 0
},
"nonRefundable": {
"type": "boolean",
"example": false
},
"invoiceItemTypeId": {
"type": "integer",
"example": 2
},
"invoiceItemTypeName": {
"type": "string",
"example": "Credit"
},
"automaticDisbursement": {
"type": "boolean",
"example": false
},
"isTaxExempt": {
"type": "boolean",
"example": false
},
"isManual": {
"type": "boolean",
"example": true
},
"createdByUserId": {
"type": "integer",
"example": 153
},
"createdByUserName": {
"type": "string",
"example": "admin"
}
},
"required": [
"identity",
"accountId",
"accountName",
"serviceId",
"serviceName",
"amount",
"detail",
"periodStart",
"periodEnd",
"credit",
"date",
"posting",
"bulkQuantity",
"nonRefundable",
"invoiceItemTypeId",
"invoiceItemTypeName",
"automaticDisbursement",
"isTaxExempt",
"isManual",
"createdByUserId",
"createdByUserName"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
},
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 15
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "invoiceItemTax"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 15
},
"invoiceItemId": {
"type": "integer",
"example": 11
},
"amount": {
"type": "number",
"example": 0.8
},
"taxRateId": {
"type": "integer",
"example": 187
},
"taxRateName": {
"type": "string",
"example": "GST"
},
"taxCodeId": {
"type": "integer",
"example": 1
},
"taxCodeName": {
"type": "string",
"example": "Canada"
},
"amountReportable": {
"type": "number",
"example": 0
}
},
"required": [
"identity",
"invoiceItemId",
"amount",
"taxRateId",
"taxRateName",
"taxCodeId",
"taxCodeName",
"amountReportable"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
},
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "creditInvoiceDisbursement"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"invoiceId": {
"type": "integer",
"example": 18332
},
"invoiceName": {
"type": "string",
"example": "18332"
},
"amount": {
"type": "number",
"example": 10
},
"invoiceItemId": {
"type": "integer",
"example": 11
},
"baseAmount": {
"type": "number",
"example": 10
},
"invoiceAmount": {
"type": "number",
"example": 10
}
},
"required": [
"identity",
"invoiceId",
"invoiceName",
"amount",
"invoiceItemId",
"baseAmount",
"invoiceAmount"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
},
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 18332
},
"action": {
"type": "string",
"example": "updated"
},
"dtoTypeKey": {
"type": "string",
"example": "invoice"
}
},
"required": [
"identity",
"action",
"dtoTypeKey"
]
},
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "creditItem"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 4
},
"invoiceItemId": {
"type": "integer",
"example": 11
},
"showOnInvoice": {
"type": "boolean",
"example": true
},
"showOnCreditNote": {
"type": "boolean",
"example": true
}
},
"required": [
"identity",
"invoiceItemId",
"showOnInvoice",
"showOnCreditNote"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"InvoiceItemCreditParam": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"example": 153
},
"accountName": {
"type": "string",
"example": "admin"
},
"amount": {
"type": "number",
"example": -10
},
"date": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"posting": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"serviceId": {
"type": "integer",
"example": 1
},
"serviceName": {
"type": "string",
"example": ""
},
"detail": {
"type": "string",
"example": "Sample Text"
},
"periodStart": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"periodEnd": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"showOnInvoice": {
"type": "boolean",
"example": true
},
"showOnCreditNote": {
"type": "boolean",
"example": true
},
"details": {
"type": "object",
"properties": {
"creditDisbursements": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"invoiceId": {
"type": "integer",
"example": 18332
},
"amount": {
"type": "number",
"example": 10
}
},
"required": [
"invoiceId",
"amount"
]
}
}
},
"required": [
"items"
]
}
},
"required": [
"creditDisbursements"
]
}
},
"required": [
"accountId",
"accountName",
"amount",
"date",
"posting",
"serviceId",
"serviceName",
"detail",
"periodStart",
"periodEnd",
"showOnInvoice",
"showOnCreditNote",
"details"
]
},
"InvoiceItemChargeResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "da5930e5-dd56-4c15-812c-1d7033d88abe"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 149
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "invoiceItem"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 149
},
"accountId": {
"type": "integer",
"example": 6243
},
"accountName": {
"type": "string",
"example": "Sample Account"
},
"serviceId": {
"type": "integer",
"example": 1
},
"serviceName": {
"type": "string",
"example": "Extreme DSL Service"
},
"amount": {
"type": "number",
"example": 20
},
"detail": {
"type": "string",
"example": "sss"
},
"periodStart": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T00:00:00Z"
},
"periodEnd": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T00:00:00Z"
},
"prorated": {
"type": "boolean",
"example": false
},
"date": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T00:00:00Z"
},
"posting": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T00:00:00Z"
},
"invoiceItemTypeId": {
"type": "integer",
"example": 8
},
"invoiceItemTypeName": {
"type": "string",
"example": "One Time Charge"
},
"isManual": {
"type": "boolean",
"example": true
},
"createdByUserId": {
"type": "integer",
"example": 8000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"quantity": {
"type": "integer",
"example": 1
},
"generalLedgerId": {
"type": "integer",
"example": 100
},
"generalLedgerName": {
"type": "string",
"example": "MRC"
},
"serviceTaxCategoryId": {
"type": "integer",
"example": 600
},
"serviceTaxCategoryName": {
"type": "string",
"example": "No Tax"
},
"preDiscountAmount": {
"type": "number",
"example": 20
},
"isTaxInclusive": {
"type": "boolean",
"example": false
},
"invoicerAccountId": {
"type": "integer",
"example": 6243
},
"invoicerAccountName": {
"type": "string",
"example": "Sample Account"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T22:32:15.36Z"
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2024-08-12T22:32:15.44Z"
},
"isTaxedOnCreate": {
"type": "boolean",
"example": true
},
"baseInvoiceItemTypeId": {
"type": "integer",
"example": 0
},
"baseInvoiceItemTypeName": {
"type": [
"string",
"null"
],
"example": null
},
"unitAmount": {
"type": "number",
"example": 20
}
},
"required": [
"identity",
"accountId",
"accountName",
"serviceId",
"serviceName",
"amount",
"detail",
"periodStart",
"periodEnd",
"prorated",
"date",
"posting",
"invoiceItemTypeId",
"invoiceItemTypeName",
"isManual",
"createdByUserId",
"createdByUserName",
"quantity",
"generalLedgerId",
"generalLedgerName",
"serviceTaxCategoryId",
"serviceTaxCategoryName",
"preDiscountAmount",
"isTaxInclusive",
"invoicerAccountId",
"invoicerAccountName",
"created",
"updated",
"isTaxedOnCreate",
"baseInvoiceItemTypeId",
"baseInvoiceItemTypeName",
"unitAmount"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"InvoiceItemChargeParam": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"example": 6243
},
"date": {
"type": "string",
"format": "date",
"example": "2024-08-12"
},
"detail": {
"type": "string",
"example": "Test data"
},
"periodStart": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"periodEnd": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": null
},
"posting": {
"type": "string",
"format": "date",
"example": "2024-08-12"
},
"serviceId": {
"type": "integer",
"example": 1
},
"amount": {
"type": "number",
"example": 20
},
"generalLedgerId": {
"type": "integer",
"example": 100
},
"isTaxInclusive": {
"type": "boolean",
"example": false
},
"applyTaxNow": {
"type": "boolean",
"example": true
},
"quantity": {
"type": "integer",
"example": 1
},
"serviceTaxCategoryId": {
"type": "integer",
"example": 600
}
},
"required": [
"accountId",
"date",
"detail",
"periodStart",
"periodEnd",
"posting",
"serviceId",
"amount",
"generalLedgerId",
"isTaxInclusive",
"applyTaxNow",
"quantity",
"serviceTaxCategoryId"
]
},
"InvoiceByUdrMediatedIdResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "732c9a3d-f0a5-4109-9be7-96c6431cac56"
},
"instance": {
"type": "object",
"properties": {
"usageMediatedId": {
"type": "integer",
"example": 985
},
"udrUsageIdentifier": {
"type": "string",
"example": "123-965"
},
"usageRatedId": {
"type": "integer",
"example": 1039
},
"accountName": {
"type": "string",
"example": "Sample Account"
},
"accountServiceName": {
"type": "string",
"example": "Sample Service"
},
"usageDate": {
"type": "string",
"format": "date-time",
"example": "2024-03-21T00:00:00Z"
},
"ratingStatus": {
"type": "string",
"example": "Consistent"
},
"billedOn": {
"type": "string",
"format": "date-time",
"example": "2024-03-21T16:21:51.897Z"
},
"invoiceId": {
"type": "integer",
"example": 150
},
"invoiceItemId": {
"type": "integer",
"example": 2544
}
},
"required": [
"usageMediatedId",
"udrUsageIdentifier",
"usageRatedId",
"accountName",
"accountServiceName",
"usageDate",
"ratingStatus",
"billedOn",
"invoiceId",
"invoiceItemId"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"OrderProcessParam": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"example": 25
},
"contactId": {
"type": "integer",
"example": 4
},
"invoiceId": {
"type": "integer",
"example": 8
},
"orderStatusTypeId": {
"type": "integer",
"example": 23
},
"companyName": {
"type": "string",
"example": "Acme Co."
},
"externalIdentifier": {
"type": "string",
"example": "124567-23"
},
"completed": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"purchaseOrderNumber": {
"type": "string",
"example": "PO123454"
},
"totalAmountEstimate": {
"type": "number",
"example": 456.67
},
"preAuthTransactionIdentifier": {
"type": "string",
"example": "236958"
},
"createdByUserId": {
"type": "integer",
"example": 1
},
"statusUpdated": {
"type": "string",
"format": "date-time",
"example": "2021-04-26T15:25:27.587Z"
},
"details": {
"type": "object",
"properties": {
"orderPackages": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"example": "DSL Package"
},
"packageFrequencyName": {
"type": "string",
"example": "DSL Package - 1 Month"
},
"quantity": {
"type": "integer",
"example": 50
}
},
"required": [
"packageName",
"packageFrequencyName",
"quantity"
]
}
}
},
"required": [
"items"
]
}
},
"required": [
"orderPackages"
]
}
},
"required": [
"accountId",
"contactId",
"invoiceId",
"orderStatusTypeId",
"companyName",
"externalIdentifier",
"completed",
"purchaseOrderNumber",
"totalAmountEstimate",
"preAuthTransactionIdentifier",
"createdByUserId",
"statusUpdated",
"details"
]
},
"PackageAvailableForCurrencyIdResults": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
}
],
"description": "List of packages available for the specified currency."
},
"PackageServicePricePlanAvailableForResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "bc7b30cb-cb26-44f3-9a52-819adadb8721"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 2069
},
"packageServiceId": {
"type": "integer",
"example": 1
},
"packageFrequencyId": {
"type": "integer",
"example": 45
},
"packageFrequencyName": {
"type": "string",
"example": "DSL Package - 1 Month"
},
"packageCurrencyId": {
"type": "integer",
"example": 3
},
"isCountOnFirstUsage": {
"type": "boolean",
"example": false
},
"packageId": {
"type": "integer",
"example": 1
},
"packageName": {
"type": "string",
"example": "DSL Package"
},
"serviceId": {
"type": "integer",
"example": 1
},
"serviceName": {
"type": "string",
"example": "Extreme DSL Service"
},
"packageFrequencyPackageCurrencyIsActive": {
"type": "boolean",
"example": true
},
"currencyId": {
"type": "integer",
"example": 1
},
"currencyName": {
"type": "string",
"example": "United States Dollar"
},
"currencyCode": {
"type": "string",
"example": "USD"
},
"statusTierTypeId": {
"type": "integer",
"example": 1
},
"statusTierTypeName": {
"type": "string",
"example": "Not Tiered"
}
},
"required": [
"identity",
"packageServiceId",
"packageFrequencyId",
"packageFrequencyName",
"packageCurrencyId",
"isCountOnFirstUsage",
"packageId",
"packageName",
"serviceId",
"serviceName",
"packageFrequencyPackageCurrencyIsActive",
"currencyId",
"currencyName",
"currencyCode",
"statusTierTypeId",
"statusTierTypeName"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"PackageServicePricePlanParam": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
13,
20,
12,
41
]
},
"ReportDefinitionIdGeneratedResult": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportStorage"
}
}
}
}
],
"description": "List of generated report storage records."
},
"ReportDefinitionIdLastGeneratedResult": {
"$ref": "#/components/schemas/ReportStorageResult"
},
"ReportDefinitionIdDownloadLastGeneratedResult": {
"$ref": "#/components/schemas/ReportStorageResult"
},
"ReportDefinitionIdRenderResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "8d886381-846a-4818-8c31-bfede7b558a2"
},
"type": {
"type": "string",
"example": "sendMessage"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 214
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "reportStorage"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 214
},
"identifier": {
"type": "string",
"format": "uuid",
"example": "81015f2b-e8cd-43ce-b26d-3173..."
},
"created": {
"type": "string",
"format": "date-time",
"example": "2024-06-07T14:17:44.717Z"
},
"createdByUserId": {
"type": "integer",
"example": 10000000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"reportContentTypeId": {
"type": "integer",
"example": 1
},
"reportContentTypeName": {
"type": "string",
"example": "PDF"
},
"reportStorageTypeId": {
"type": "integer",
"example": 1
},
"reportStorageTypeName": {
"type": "string",
"example": "On-Demand"
},
"reportDefinitionId": {
"type": "integer",
"example": 100
},
"reportDefinitionName": {
"type": "string",
"example": "Account List"
},
"storageLocationId": {
"type": "integer",
"example": 2
},
"storageLocationName": {
"type": "string",
"example": "S3 Reports"
},
"reportStorageStatusTypeId": {
"type": "integer",
"example": 1
},
"reportStorageStatusTypeName": {
"type": "string",
"example": "Pending"
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2024-06-07T14:17:44.717Z"
},
"requestParameter": {
"type": "string",
"example": "{ \"suppressNotification\": false }"
}
},
"required": [
"identity",
"identifier",
"created",
"createdByUserId",
"createdByUserName",
"reportContentTypeId",
"reportContentTypeName",
"reportStorageTypeId",
"reportStorageTypeName",
"reportDefinitionId",
"reportDefinitionName",
"storageLocationId",
"storageLocationName",
"reportStorageStatusTypeId",
"reportStorageStatusTypeName",
"updated",
"requestParameter"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
},
{
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "messageSent"
},
"dtoTypeKey": {
"type": "string",
"example": "renderResults"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 100
},
"successful": {
"type": "boolean",
"example": true
}
},
"required": [
"identity",
"successful"
]
}
},
"required": [
"action",
"dtoTypeKey",
"instance"
]
}
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"RerateNowParam": {
"type": "object",
"description": "Request payload used to queue rerating for a single account.",
"additionalProperties": false,
"properties": {
"accountId": {
"type": [
"integer",
"null"
],
"example": 10000003,
"description": "Account identifier to rerate."
},
"accountName": {
"type": [
"string",
"null"
],
"example": "Acme Telecom",
"description": "Fallback account name used when accountId is not supplied. It must resolve to a single account."
},
"rerateStart": {
"type": [
"string",
"null"
],
"format": "date",
"example": "2026-03-01",
"description": "Rerate window start date."
},
"scheduledByUserId": {
"type": [
"integer",
"null"
],
"example": 10000000,
"description": "Optional user identifier to associate with the rerate request."
}
},
"anyOf": [
{
"required": [
"accountId"
]
},
{
"required": [
"accountName"
]
}
]
},
"RerateNowResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "4975a502-0036-436c-9148-994e17b34d82"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 11
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "rerateSchedule"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 11
},
"created": {
"type": "string",
"format": "date-time",
"example": "2024-05-06T10:29:55.733Z"
},
"createdByUserId": {
"type": "integer",
"example": 8000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"rerateScheduleStatusTypeId": {
"type": "integer",
"example": 1
},
"rerateScheduleStatusTypeName": {
"type": "string",
"example": "Queued"
}
},
"required": [
"identity",
"created",
"createdByUserId",
"createdByUserName",
"rerateScheduleStatusTypeId",
"rerateScheduleStatusTypeName"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
},
{
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 18
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "rerate"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 18
},
"rerateScheduleId": {
"type": "integer",
"example": 11
},
"accountId": {
"type": "integer",
"example": 10000003
},
"accountName": {
"type": "string",
"example": "Sample Account"
},
"rerateStart": {
"type": "string",
"format": "date-time",
"example": "2024-01-01T00:00:00Z"
},
"rerateTypeId": {
"type": "integer",
"example": 3
},
"rerateTypeName": {
"type": "string",
"example": "Parent and Children"
},
"createdByUserId": {
"type": "integer",
"example": 8000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2024-05-06T10:29:55.73Z"
},
"rerateReasonTypeId": {
"type": "integer",
"example": 99
},
"rerateReasonTypeName": {
"type": "string",
"example": "User Initiated"
}
},
"required": [
"identity",
"rerateScheduleId",
"accountId",
"accountName",
"rerateStart",
"rerateTypeId",
"rerateTypeName",
"createdByUserId",
"createdByUserName",
"created",
"rerateReasonTypeId",
"rerateReasonTypeName"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"RerateNowBatchParam": {
"type": "object",
"description": "Request payload used to queue rerating for multiple accounts.",
"additionalProperties": false,
"properties": {
"rerateStart": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Default rerate start date applied to all accounts unless overridden on an individual account item.",
"example": "2026-03-01"
},
"accountsToRerate": {
"type": "object",
"description": "Accounts that should be included in the rerate batch.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": [
"integer",
"null"
],
"description": "Account identifier to rerate.",
"example": 153
},
"accountName": {
"type": [
"string",
"null"
],
"description": "Fallback account name used when accountId is not supplied. It must resolve to a single account.",
"example": "Acme Telecom"
},
"rerateStart": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Optional per-account rerate start date override.",
"example": "2026-03-15"
}
},
"anyOf": [
{
"required": [
"accountId"
]
},
{
"required": [
"accountName"
]
}
]
}
}
},
"required": [
"items"
]
}
},
"required": [
"accountsToRerate"
]
},
"RerateNowBatchResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "f692cbbf-3dd0-4767-a927-1250ac20b51b"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 1
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "rerateSchedule"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 1
},
"created": {
"type": "string",
"format": "date-time",
"example": "2025-12-05T19:04:52.783Z"
},
"createdByUserId": {
"type": "integer",
"example": 8000
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support"
},
"rerateScheduleStatusTypeId": {
"type": "integer",
"example": 1
},
"rerateScheduleStatusTypeName": {
"type": "string",
"example": "Queued"
}
},
"required": [
"identity",
"created",
"createdByUserId",
"createdByUserName",
"rerateScheduleStatusTypeId",
"rerateScheduleStatusTypeName"
]
}
},
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"UsageBucketSharePlanActivationTypeResult": {
"type": "object",
"properties": {
"top": {
"type": "integer",
"example": 10000
},
"trackingId": {
"type": "string",
"format": "uuid",
"example": "3c03d2f6-d2b4-485c-8e01-fbb59dfe20e3"
},
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 2
},
"name": {
"type": "string",
"example": "Participating Service"
},
"description": {
"type": "string",
"example": "Participating Service"
}
},
"required": [
"identity",
"name",
"description"
]
}
}
},
"required": [
"top",
"trackingId",
"totalCount",
"items"
]
},
"UserUserNameLoginHistoryResult": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserLoginHistory"
}
}
}
}
],
"description": "List of login history entries for the specified user."
},
"UserUserIdLoginHistoryResult": {
"$ref": "#/components/schemas/UserUserNameLoginHistoryResult"
},
"AccountPackageFromCatalogResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "3bc9fc24-52e0-49d2-a3fb-a6e4f30e150b"
},
"type": {
"type": "string",
"example": "create"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 7
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 3175
},
"action": {
"type": "string",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"example": "accountPackage"
},
"instance": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 3175
},
"accountId": {
"type": "integer",
"example": 10000004
},
"accountName": {
"type": "string",
"example": "Anthem Records"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2022-11-03T02:03:45.347Z"
},
"nextBill": {
"type": "string",
"format": "date-time",
"example": "2022-11-03T00:00:00Z"
},
"name": {
"type": "string",
"example": "DSL Package (C67CB254)"
},
"effective": {
"type": "string",
"format": "date-time",
"example": "2022-11-03T02:03:45.367Z"
},
"packageFrequencyId": {
"type": "integer",
"example": 45
},
"packageFrequencyName": {
"type": "string",
"example": "DSL Package - 1 Month"
},
"termId": {
"type": [
"integer",
"null"
],
"example": null
},
"createdByUserId": {
"type": "integer",
"example": 153
},
"createdByUserName": {
"type": "string",
"example": "admin"
},
"billDay": {
"type": "integer",
"example": 3
},
"usageBillDay": {
"type": "integer",
"example": 3
},
"packageCategoryId": {
"type": "integer",
"example": 2
},
"packageCategoryName": {
"type": "string",
"example": "Default"
},
"chargeRecurringIfUsage": {
"type": "boolean",
"example": false
},
"waiveEarlyTerminationFee": {
"type": "boolean",
"example": false
},
"quantity": {
"type": "integer",
"example": 10
},
"isQuantityAllowed": {
"type": "boolean",
"example": true
},
"priceBookId": {
"type": "integer",
"example": 1
},
"priceBookName": {
"type": "string",
"example": "Standard Price Book"
},
"serviceId": {
"type": "integer",
"example": 1
},
"serviceName": {
"type": "string",
"example": "Extreme DSL Service"
},
"accountPackageId": {
"type": "integer",
"example": 3175
},
"accountPackageName": {
"type": "string",
"example": "DSL Package (C67CB254)"
},
"usageNextBill": {
"type": "string",
"format": "date-time",
"example": "2023-02-03T00:00:00Z"
},
"accountServiceId": {
"type": "integer",
"example": 20123
},
"accountServiceName": {
"type": "string",
"example": "Extreme DSL Service (FC6F871A)"
},
"serviceStatusTypeId": {
"type": "integer",
"example": 12
},
"serviceStatusTypeName": {
"type": "string",
"example": "Active"
},
"accountPackageStatusTypeId": {
"type": "integer",
"example": 99
},
"accountPackageStatusTypeName": {
"type": "string",
"example": "Active"
}
}
}
},
"required": [
"identity",
"action",
"dtoTypeKey"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"AccountPackageFromCatalogParam": {
"type": "object",
"properties": {
"accountName": {
"type": "string",
"example": "Anthem Records"
},
"accountProductCodeName": {
"type": "string",
"example": "DU-0001"
},
"packageName": {
"type": "string",
"example": "DSL Package"
},
"packageFrequencyName": {
"type": "string",
"example": "DSL Package - 1 Month"
},
"packageFrequencyId": {
"type": "integer",
"example": 45
},
"accountPackageName": {
"type": "string",
"example": "Anthem DSL"
},
"effective": {
"type": "string",
"example": "2019-05-23T00:00:00Z"
},
"nextBill": {
"type": "string",
"example": "2020-01-01"
},
"quantity": {
"type": "number",
"example": 2
},
"useBulkQuantity": {
"type": "boolean",
"example": true
},
"applyDefaultDiscount": {
"type": "boolean",
"example": true
},
"billDay": {
"type": "integer",
"example": 20
},
"usageBillDay": {
"type": "integer",
"example": 18
},
"nonBillableAccountPackageStatusTypeName": {
"type": "string",
"example": "Pre-Active"
},
"accountPackageStatusTypeName": {
"type": "string",
"example": "Suspended"
},
"discountPromoCodeName": {
"type": "string",
"example": "Test Promocode"
},
"discountPromoCodeId": {
"type": "integer",
"example": 1
},
"taxAddressId": {
"type": "integer",
"example": 16
},
"taxAddress": {
"type": "object",
"properties": {
"instance": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"cityName": {
"type": "string"
},
"isIncorporated": {
"type": "boolean"
},
"stateCode": {
"type": "string"
},
"countryCode": {
"type": "string"
}
}
}
}
},
"attributes": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"usageIdentifier": {
"type": "string"
},
"usageRatePlanName": {
"type": "string"
},
"extensions": {
"type": "object",
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"services": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer"
},
"name": {
"type": "string"
},
"quantity": {
"type": "number"
},
"effective": {
"type": "string"
},
"usageIdentifier": {
"type": "string"
},
"usageNextBill": {
"type": "string"
},
"serviceStatusTypeName": {
"type": "string"
},
"accountServiceName": {
"type": "string"
},
"addOnPackageName": {
"type": "string"
},
"addOnPackageFrequencyName": {
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/AccountPackageFromCatalogParam/properties/attributes"
}
},
"additionalProperties": true
}
}
}
},
"recurringPriceOverrides": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceName": {
"type": "string"
},
"serviceStatusTypeName": {
"type": "string"
},
"amount": {
"type": "number"
}
},
"required": [
"serviceName",
"amount"
]
}
}
}
},
"nonRecurringPriceOverrides": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceName": {
"type": "string"
},
"amount": {
"type": "number"
}
},
"required": [
"serviceName",
"amount"
]
}
}
}
},
"transitionPriceOverrides": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serviceName": {
"type": "string"
},
"serviceTransitionName": {
"type": "string"
},
"chargeServiceName": {
"type": "string"
},
"amount": {
"type": "number"
}
},
"required": [
"serviceName",
"amount"
]
}
}
}
},
"extensions": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"accountName"
],
"anyOf": [
{
"required": [
"accountProductCodeName"
]
},
{
"required": [
"packageFrequencyId"
]
},
{
"required": [
"packageName",
"packageFrequencyName"
]
}
]
},
"AccountPackageIdHasBucketedUsageResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "d16bb9a9-d6c5-4009-995f-400c58bd96a8"
},
"instance": {
"type": "object",
"properties": {
"hasBucketedUsage": {
"type": "boolean",
"example": false
}
},
"required": [
"hasBucketedUsage"
]
}
},
"required": [
"trackingId",
"instance"
]
},
"AccountProductCodeAvailableForResult": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountProductCodeAvailableFor"
}
}
}
}
],
"description": "List of account product codes available for selection."
},
"AccountServiceIdCurrentResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountService"
}
}
}
],
"description": "Single current account service result envelope."
},
"AccountIdBalanceResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/AccountBalanceSummary"
}
}
}
],
"description": "Single account balance summary result envelope."
},
"InvoiceIdDownloadResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/InvoiceDownload"
}
}
}
],
"description": "Single invoice download result envelope."
},
"InvoiceIdReRenderParam": {
"type": "object",
"properties": {
"createReportAttachments": {
"type": "boolean",
"example": true
}
},
"required": [
"createReportAttachments"
]
},
"InvoiceIdReRenderResult": {
"type": "object",
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"example": "1e6daca6-6126-4db0-8ba8-3f90cbcaa4c5"
},
"type": {
"type": "string",
"example": "sendMessage"
},
"results": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "integer",
"example": 18337
},
"action": {
"type": "string",
"example": "updated"
},
"dtoTypeKey": {
"type": "string",
"example": "invoice"
}
},
"required": [
"identity",
"action",
"dtoTypeKey"
]
}
}
},
"required": [
"totalCount",
"items"
]
}
},
"required": [
"trackingId",
"type",
"results"
]
},
"PaymentTypeRecordIdParam": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "BMO check"
},
"paymentBaseTypeId": {
"type": "integer",
"example": 3
},
"paymentTypeDisbursementTypeId": {
"type": "integer",
"example": 1
},
"isActive": {
"type": "integer",
"description": "Flag indicating if the payment type is active (1 = true, 0 = false)",
"example": 1
}
},
"required": [
"name",
"paymentBaseTypeId",
"paymentTypeDisbursementTypeId",
"isActive"
]
},
"PaymentTypeRecordIdResult": {
"type": "object",
"additionalProperties": false,
"required": [
"trackingId",
"type",
"results"
],
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"description": "Unique tracking identifier for the operation."
},
"type": {
"type": "string",
"description": "Operation type",
"example": "create"
},
"results": {
"type": "object",
"additionalProperties": false,
"required": [
"totalCount",
"items"
],
"properties": {
"totalCount": {
"type": "integer",
"format": "int32",
"description": "Total number of result items",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"identity",
"action",
"dtoTypeKey",
"instance"
],
"properties": {
"identity": {
"type": "integer",
"format": "int32",
"description": "Identity of the created or affected record",
"example": 19
},
"action": {
"type": "string",
"description": "Action performed on the record",
"example": "created"
},
"dtoTypeKey": {
"type": "string",
"description": "DTO type key",
"example": "paymentType"
},
"instance": {
"type": "object",
"additionalProperties": false,
"required": [
"identity",
"name",
"paymentBaseTypeId",
"paymentBaseTypeName",
"paymentTypeDisbursementTypeId",
"paymentTypeDisbursementTypeName",
"isActive",
"paymentProviderId",
"paymentProviderName"
],
"properties": {
"identity": {
"type": "integer",
"format": "int32",
"example": 19
},
"name": {
"type": "string",
"example": "BMO check"
},
"paymentBaseTypeId": {
"type": "integer",
"format": "int32",
"example": 3
},
"paymentBaseTypeName": {
"type": "string",
"example": "Cash"
},
"paymentTypeDisbursementTypeId": {
"type": "integer",
"format": "int32",
"example": 1
},
"paymentTypeDisbursementTypeName": {
"type": "string",
"example": "Automatic"
},
"isActive": {
"type": "boolean",
"example": true
},
"paymentProviderId": {
"type": [
"integer",
"null"
],
"format": "int32",
"example": null
},
"paymentProviderName": {
"type": [
"string",
"null"
],
"example": null
}
}
}
}
}
}
}
}
}
},
"CreditNoteSendParam": {
"type": "object",
"additionalProperties": false,
"required": [
"creditNoteRenderId",
"invoiceDeliveryTypeId",
"emailTemplateId",
"contactId"
],
"properties": {
"creditNoteRenderId": {
"type": "integer",
"format": "int32",
"description": "Identifier of the rendered credit note to be sent.",
"example": 22
},
"invoiceDeliveryTypeId": {
"type": "integer",
"format": "int32",
"description": "Delivery method identifier (e.g., email, print, etc.).",
"example": 1
},
"emailTemplateId": {
"type": "integer",
"format": "int32",
"description": "Identifier of the email template used for sending the credit note.",
"example": 2
},
"contactId": {
"type": "integer",
"format": "int32",
"description": "Identifier of the contact receiving the credit note.",
"example": 86
}
}
},
"CreditNoteSendResult": {
"type": "object",
"additionalProperties": false,
"required": [
"trackingId",
"type",
"results"
],
"properties": {
"trackingId": {
"type": "string",
"format": "uuid",
"description": "Unique tracking identifier for the operation.",
"example": "204f608e-a3a9-42d3-93e6-f8a02861dfe4"
},
"type": {
"type": "string",
"description": "Operation type",
"example": "sendMessage"
},
"results": {
"type": "object",
"additionalProperties": false,
"required": [
"totalCount",
"items"
],
"properties": {
"totalCount": {
"type": "integer",
"format": "int32",
"description": "Total number of result items",
"example": 2
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"identity",
"action",
"dtoTypeKey"
],
"properties": {
"identity": {
"type": "integer",
"format": "int32",
"description": "Identifier of the affected entity",
"example": 86
},
"action": {
"type": "string",
"description": "Action performed",
"example": "messageSent"
},
"dtoTypeKey": {
"type": "string",
"description": "DTO type key indicating the entity type",
"example": "contact"
}
}
}
}
}
}
}
},
"PackageFrequencyListResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"description": "List response containing package frequencies available for the requested package and currency.",
"type": "object",
"properties": {
"items": {
"description": "Package frequencies that can be used for the specified package and currency.",
"items": {
"$ref": "#/components/schemas/PackageFrequency"
},
"type": "array"
}
}
}
]
},
"UsageClassListResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"description": "List response containing usage classes available for the requested rate group and base unit.",
"type": "object",
"properties": {
"items": {
"description": "Usage classes compatible with the specified rate group and base unit.",
"items": {
"$ref": "#/components/schemas/UsageClass"
},
"type": "array"
}
}
}
]
},
"MonthlyUsageSummaryPagedResponse": {
"allOf": [
{
"$ref": "#/components/schemas/PagedResultBase"
},
{
"description": "Paged response containing monthly usage summary rows for an account.",
"type": "object",
"properties": {
"pagedResults": {
"$ref": "#/components/schemas/MonthlyUsageSummaryPagedResults"
}
}
}
]
},
"MonthlyUsageSummaryPagedResults": {
"description": "Paged collection of monthly usage summary rows.",
"type": "object",
"properties": {
"items": {
"description": "Monthly usage summary rows returned for the requested page.",
"items": {
"$ref": "#/components/schemas/MonthlyUsageSummaryItem"
},
"type": "array"
},
"totalCount": {
"example": 24,
"description": "Total number of matching summary rows when total counts are included.",
"type": [
"integer",
"null"
]
}
},
"required": [
"items"
],
"additionalProperties": false
},
"MonthlyUsageSummaryItem": {
"description": "Aggregated monthly usage totals for an account, service, and package combination.",
"type": "object",
"properties": {
"usageTotal": {
"example": 18432,
"description": "Aggregated usage amount for the row, expressed in the usage base unit.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"usageYear": {
"example": 2026,
"description": "Usage year represented by the summary row.",
"type": [
"integer",
"null"
]
},
"packageName": {
"example": "Corporate Wireless",
"description": "Name of the package associated with the service.",
"type": "string"
},
"udrUsageIdentifier": {
"example": "SIM-89014103211118510720",
"description": "Usage identifier used to group mediated usage records, such as a SIM or circuit identifier.",
"type": [
"string",
"null"
]
},
"displayUsageTotal": {
"example": "18,432 MB",
"description": "Formatted usage total intended for display.",
"type": [
"string",
"null"
]
},
"usageMonth": {
"example": 3,
"description": "Usage month represented by the summary row.",
"type": [
"integer",
"null"
]
},
"usageBaseUnitName": {
"example": "Megabyte",
"description": "Name of the unit used to measure the usage total.",
"type": "string"
},
"packageId": {
"example": 300,
"description": "Unique identifier of the package associated with the service.",
"type": "integer"
},
"serviceId": {
"example": 55021,
"description": "Unique identifier of the service.",
"type": "integer"
},
"serviceName": {
"example": "LTE Data Plan",
"description": "Name of the service.",
"type": "string"
},
"accountId": {
"example": 1024,
"description": "Unique identifier of the account.",
"type": "integer"
},
"usageBillPeriodStartDate": {
"example": "2026-03-01T00:00:00Z",
"description": "UTC start date of the billing period used for the usage summary row.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"accountName": {
"example": "Acme Telecom",
"description": "Name of the account.",
"type": "string"
},
"usageBaseUnitId": {
"example": 5,
"description": "Unique identifier of the unit used to measure the usage total.",
"type": [
"integer",
"null"
]
}
},
"required": [
"accountId",
"accountName",
"serviceId",
"serviceName",
"packageId",
"packageName",
"usageBaseUnitName"
],
"additionalProperties": false
},
"PaginationHeader": {
"description": "Paging settings applied to the response.",
"type": "object",
"properties": {
"excludeTotalCount": {
"example": false,
"description": "Indicates whether the response skipped calculating the total number of matching records.",
"type": "boolean"
},
"pageSize": {
"example": 20,
"description": "Maximum number of items returned per page.",
"type": "integer"
},
"pageNumber": {
"example": 1,
"description": "1-based page number returned in the response.",
"type": "integer"
}
},
"required": [
"pageNumber",
"pageSize",
"excludeTotalCount"
],
"additionalProperties": false
},
"AccountTaxAddressAvailableForResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"description": "List response containing tax addresses that can be linked to an account.",
"type": "object",
"properties": {
"items": {
"description": "Tax addresses available to associate with the account.",
"items": {
"$ref": "#/components/schemas/AccountTaxAddressAvailableForItem"
},
"type": "array"
}
}
}
]
},
"AccountTaxAddressAvailableForItem": {
"description": "Tax address option that can be associated with an account.",
"type": "object",
"properties": {
"name": {
"example": "Primary Tax Address",
"description": "Display name assigned to the tax address.",
"type": [
"string",
"null"
]
},
"taxAddressId": {
"example": 501,
"description": "Unique identifier of the tax address record.",
"type": "integer"
},
"invoicerAccountId": {
"example": 100,
"description": "Unique identifier of the invoicer account that owns the tax address.",
"type": [
"integer",
"null"
]
},
"invoicerAccountName": {
"example": "North America Invoicer",
"description": "Name of the invoicer account that owns the tax address.",
"type": "string"
},
"addressId": {
"example": 9001,
"description": "Unique identifier of the underlying address record.",
"type": "integer"
},
"accountId": {
"example": 1024,
"description": "Unique identifier of the account currently linked to the tax address, when one exists.",
"type": [
"integer",
"null"
]
},
"accountName": {
"example": "Acme Telecom",
"description": "Name of the account currently linked to the tax address, when one exists.",
"type": [
"string",
"null"
]
},
"isInvoicerTaxAddress": {
"example": 0,
"description": "Flag indicating whether this is the invoicer's own tax address.",
"type": "integer"
}
},
"required": [
"addressId",
"taxAddressId",
"invoicerAccountName",
"isInvoicerTaxAddress"
],
"additionalProperties": false
},
"AccountTaxAddressResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MultipleResultBase"
},
{
"description": "List response containing tax addresses currently associated with an account.",
"type": "object",
"properties": {
"items": {
"description": "Tax addresses currently associated with the account.",
"items": {
"$ref": "#/components/schemas/AccountTaxAddressItem"
},
"type": "array"
}
}
}
]
},
"AccountTaxAddressItem": {
"description": "Tax address record associated with an account.",
"type": "object",
"properties": {
"countryName": {
"example": "United States",
"description": "Country associated with the address.",
"type": [
"string",
"null"
]
},
"accountName": {
"example": "Acme Telecom",
"description": "Name of the account currently linked to the tax address.",
"type": [
"string",
"null"
]
},
"isInvoicerTaxAddress": {
"example": 0,
"description": "Flag indicating whether this is the invoicer's own tax address.",
"type": "integer"
},
"zipCode": {
"example": "10001",
"description": "Postal or ZIP code.",
"type": [
"string",
"null"
]
},
"countryId": {
"example": 1,
"description": "Unique identifier of the country.",
"type": [
"integer",
"null"
]
},
"invoicerAccountId": {
"example": 100,
"description": "Unique identifier of the invoicer account that owns the tax address.",
"type": [
"integer",
"null"
]
},
"address1": {
"example": "123 Main Street",
"description": "First address line.",
"type": "string"
},
"name": {
"example": "Primary Tax Address",
"description": "Display name assigned to the tax address.",
"type": [
"string",
"null"
]
},
"taxAddressId": {
"example": 501,
"description": "Unique identifier of the tax address record.",
"type": "integer"
},
"stateName": {
"example": "New York",
"description": "State or province associated with the address.",
"type": [
"string",
"null"
]
},
"cityName": {
"example": "New York",
"description": "City associated with the address.",
"type": [
"string",
"null"
]
},
"stateId": {
"example": 35,
"description": "Unique identifier of the state or province.",
"type": [
"integer",
"null"
]
},
"invoicerAccountName": {
"example": "North America Invoicer",
"description": "Name of the invoicer account that owns the tax address.",
"type": "string"
},
"address2": {
"example": "Suite 400",
"description": "Second address line.",
"type": [
"string",
"null"
]
},
"addressId": {
"example": 9001,
"description": "Unique identifier of the underlying address record.",
"type": "integer"
},
"taxJurisdictionCode": {
"example": 123456789,
"description": "Tax jurisdiction code used for tax calculation and reporting.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"accountId": {
"example": 1024,
"description": "Unique identifier of the account currently linked to the tax address.",
"type": [
"integer",
"null"
]
}
},
"required": [
"taxAddressId",
"addressId",
"invoicerAccountName",
"isInvoicerTaxAddress",
"address1"
],
"additionalProperties": false
},
"ActionResultItem": {
"description": "Result entry describing a resource affected by the action.",
"type": "object",
"properties": {
"rhsId": {
"example": null,
"description": "Right-hand-side identifier for mapping results when applicable.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"foreignKeyIdentity": {
"example": null,
"description": "Foreign key identifier used by bulk or delete-all style results when applicable.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"instance": {
"example": null,
"description": "Detailed resource payload when the output format includes an instance.",
"type": [
"object",
"null"
],
"additionalProperties": true
},
"lhsId": {
"example": null,
"description": "Left-hand-side identifier for mapping results when applicable.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"affected": {
"example": null,
"description": "Number of rows affected for aggregate operations when applicable.",
"type": [
"integer",
"null"
]
},
"dtoTypeKey": {
"example": "paymentMethod",
"description": "DTO type key of the affected resource.",
"type": [
"string",
"null"
]
},
"identity": {
"example": 88,
"description": "Unique identifier of the affected resource when one is available.",
"type": [
"integer",
"null"
],
"format": "int64"
},
"action": {
"example": "updated",
"description": "Action performed on the resource.",
"type": "string",
"enum": [
"created",
"retrieved",
"updated",
"deleted",
"attached",
"detached",
"tokenSet",
"tokenBound",
"messageSent",
"skipped"
]
}
},
"additionalProperties": false
},
"AccountSharePlanProductCodePatch": {
"type": "object",
"description": "Patch payload for updating product-code customization on an account share plan.",
"additionalProperties": false,
"properties": {
"accountProductCodeId": {
"type": [
"integer",
"null"
],
"description": "Optional account product code identifier when updating by ID.",
"example": 501
},
"accountProductCodeName": {
"type": [
"string",
"null"
],
"description": "Product code assigned to the account share plan. The route value is used when provided.",
"example": "PLAN-ADDON-001"
},
"details": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Optional nested customization details for the product code patch.",
"example": null
}
}
},
"InvoiceDownload": {
"type": "object",
"description": "Rendered invoice download payload.",
"additionalProperties": false,
"properties": {
"invoiceId": {
"type": "integer",
"example": 18337,
"description": "Unique identifier for the invoice."
},
"invoiceName": {
"type": "string",
"example": "18337",
"description": "Display name or number of the invoice."
},
"rendered": {
"type": "string",
"format": "date-time",
"example": "2021-06-14T02:27:00.853Z",
"description": "Date and time when the invoice PDF was rendered."
},
"pdf": {
"type": [
"string",
"null"
],
"example": "",
"description": "Base64-encoded PDF document content. This value may be omitted when linkOnly=true."
},
"accountId": {
"type": "integer",
"example": 10000003,
"description": "Unique identifier for the related account."
},
"accountName": {
"type": "string",
"example": "test",
"description": "Name of the related account."
},
"link": {
"type": "string",
"format": "uri",
"example": "https://mydomain.com/invoiceRenders/1/example.pdf?token=example",
"description": "Direct link to the rendered PDF file."
}
},
"required": [
"invoiceId",
"invoiceName",
"rendered",
"accountId",
"accountName",
"link"
]
},
"CreditNoteDownload": {
"type": "object",
"description": "Rendered credit note download payload.",
"additionalProperties": false,
"properties": {
"creditNoteId": {
"type": "integer",
"example": 82,
"description": "Unique identifier for the credit note."
},
"creditNoteName": {
"type": "string",
"example": "82",
"description": "Display name or number of the credit note."
},
"rendered": {
"type": "string",
"format": "date-time",
"example": "2021-06-14T02:19:00.367Z",
"description": "Date and time when the credit note PDF was rendered."
},
"pdf": {
"type": [
"string",
"null"
],
"example": "",
"description": "Base64-encoded PDF document content. This value may be omitted when linkOnly=true."
},
"accountId": {
"type": "integer",
"example": 10000003,
"description": "Unique identifier for the related account."
},
"accountName": {
"type": "string",
"example": "test",
"description": "Name of the related account."
},
"link": {
"type": "string",
"format": "uri",
"example": "https://mydomain.com/creditNoteRenders/1/example.pdf?token=example",
"description": "Direct link to the rendered PDF file."
}
},
"required": [
"creditNoteId",
"creditNoteName",
"rendered",
"accountId",
"accountName",
"link"
]
},
"CreditNoteIdDownloadResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/CreditNoteDownload"
}
}
}
],
"description": "Single credit note download result envelope."
},
"ReportStorage": {
"type": "object",
"description": "Stored report metadata and optional generated content or download link.",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 214,
"description": "Unique identifier for the report storage record."
},
"identifier": {
"type": "string",
"format": "uuid",
"example": "81015f2b-e8cd-43ce-b26d-3173e181cf42",
"description": "Stable identifier for the generated report."
},
"generatedResult": {
"type": [
"string",
"null"
],
"example": null,
"description": "Generated report content when returned inline."
},
"created": {
"type": "string",
"format": "date-time",
"example": "2024-06-07T14:17:44.717Z",
"description": "Date and time when the report storage record was created."
},
"createdByUserId": {
"type": "integer",
"example": 10000000,
"description": "User ID that created the report storage record."
},
"createdByUserName": {
"type": "string",
"example": "LogiSense Support",
"description": "User name that created the report storage record."
},
"reportContentTypeId": {
"type": "integer",
"example": 1,
"description": "Identifier of the report content type."
},
"reportContentTypeName": {
"type": "string",
"example": "PDF",
"description": "Name of the report content type."
},
"reportStorageTypeId": {
"type": "integer",
"example": 1,
"description": "Identifier of the report storage type."
},
"reportStorageTypeName": {
"type": "string",
"example": "On-Demand",
"description": "Name of the report storage type."
},
"generated": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2024-06-07T14:17:45Z",
"description": "Date and time when report generation completed."
},
"reportDefinitionId": {
"type": "integer",
"example": 100,
"description": "Identifier of the source report definition."
},
"reportDefinitionName": {
"type": "string",
"example": "Account List",
"description": "Name of the source report definition."
},
"storageLocationId": {
"type": "integer",
"example": 2,
"description": "Identifier of the storage location."
},
"storageLocationName": {
"type": "string",
"example": "Secure Report Storage",
"description": "Name of the storage location."
},
"reportStorageStatusTypeId": {
"type": "integer",
"example": 3,
"description": "Identifier of the report storage status."
},
"reportStorageStatusTypeName": {
"type": "string",
"example": "Generated",
"description": "Name of the report storage status."
},
"errorMessage": {
"type": [
"string",
"null"
],
"example": null,
"description": "Error message recorded during generation, when applicable."
},
"scheduleId": {
"type": [
"integer",
"null"
],
"example": null,
"description": "Schedule identifier when the report was generated by a schedule."
},
"scheduleName": {
"type": [
"string",
"null"
],
"example": null,
"description": "Schedule name when the report was generated by a schedule."
},
"updated": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2024-06-07T14:17:45.873Z",
"description": "Date and time when the storage record was last updated."
},
"link": {
"type": [
"string",
"null"
],
"format": "uri",
"example": "https://mydomain.com/reports/1/on-demand/81015f2b-e8cd-43ce-b26d-3173e181cf42.pdf?token=example",
"description": "Direct link to download the generated report file."
},
"requestParameter": {
"type": [
"string",
"null"
],
"example": "{\"suppressNotification\":false}",
"description": "Serialized request parameters used to generate the report."
}
},
"required": [
"identity",
"identifier",
"created",
"createdByUserId",
"createdByUserName",
"reportContentTypeId",
"reportContentTypeName",
"reportStorageTypeId",
"reportStorageTypeName",
"reportDefinitionId",
"reportDefinitionName",
"storageLocationId",
"storageLocationName",
"reportStorageStatusTypeId",
"reportStorageStatusTypeName"
]
},
"ReportStorageResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/ReportStorage"
}
}
}
],
"description": "Single report storage result envelope."
},
"DataImportUsageDownload": {
"type": "object",
"description": "Download payload for an imported usage file.",
"additionalProperties": false,
"properties": {
"link": {
"type": "string",
"format": "uri",
"example": "https://mydomain.com/imports/usage/source-file.csv?token=example",
"description": "Direct link to download the imported usage file."
}
},
"required": [
"link"
]
},
"DataImportUsageDownloadResult": {
"allOf": [
{
"$ref": "#/components/schemas/SingleResultBase"
},
{
"type": "object",
"properties": {
"instance": {
"$ref": "#/components/schemas/DataImportUsageDownload"
}
}
}
],
"description": "Single data import usage download result envelope."
},
"AccountSharePlanProductCodeAvailableFor": {
"type": "object",
"description": "Product code that can be attached to an account share plan.",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 27,
"description": "Unique identifier for the available product code record."
},
"name": {
"type": "string",
"example": "DU-0001",
"description": "Product code value."
},
"accountId": {
"type": "integer",
"example": 10000000,
"description": "Identifier of the related account."
},
"accountName": {
"type": "string",
"example": "Anthem Records",
"description": "Name of the related account."
},
"packageId": {
"type": "integer",
"example": 45,
"description": "Identifier of the related package."
},
"packageName": {
"type": "string",
"example": "Domestic Data Plan",
"description": "Name of the related package."
},
"packageFrequencyId": {
"type": "integer",
"example": 12,
"description": "Identifier of the related package frequency."
},
"packageFrequencyName": {
"type": "string",
"example": "Monthly",
"description": "Name of the related package frequency."
}
},
"required": [
"identity",
"name",
"accountId",
"accountName",
"packageId",
"packageName",
"packageFrequencyId",
"packageFrequencyName"
]
},
"AccountSharePlanProductCode": {
"type": "object",
"description": "Product code assignment payload for an account share plan.",
"additionalProperties": false,
"properties": {
"accountSharePlanId": {
"type": "integer",
"example": 55,
"description": "Identifier of the target account share plan."
},
"accountProductCodeId": {
"type": "integer",
"example": 501,
"description": "Identifier of the account product code."
},
"accountProductCodeName": {
"type": "string",
"example": "PLAN-ADDON-001",
"description": "Name of the account product code."
}
},
"required": [
"accountProductCodeId",
"accountProductCodeName"
]
},
"AccountProductCodeAvailableFor": {
"type": "object",
"description": "Account product code available for selection.",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 27,
"description": "Unique identifier for the account product code."
},
"name": {
"type": "string",
"example": "DU-0001",
"description": "Account product code value."
},
"accountId": {
"type": "integer",
"example": 10000000,
"description": "Identifier of the related account."
},
"accountName": {
"type": "string",
"example": "Anthem Records",
"description": "Name of the related account."
}
},
"required": [
"identity",
"name",
"accountId",
"accountName"
]
},
"AccountBalanceSummary": {
"type": "object",
"description": "Account balance summary for a point in time.",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"example": 76365,
"description": "Identifier of the account."
},
"accountName": {
"type": "string",
"example": "Sample Name",
"description": "Name of the account."
},
"balance": {
"type": "number",
"example": 60.69,
"description": "Current total balance."
},
"balanceDue": {
"type": "number",
"example": 60.69,
"description": "Current past-due balance."
}
},
"required": [
"accountId",
"accountName",
"balance",
"balanceDue"
]
},
"UserLoginHistory": {
"type": "object",
"description": "User login history entry.",
"additionalProperties": false,
"properties": {
"identity": {
"type": "integer",
"example": 7
},
"userId": {
"type": "integer",
"example": 153
},
"userName": {
"type": "string",
"example": "admin"
},
"userLoginResultTypeId": {
"type": "integer",
"example": 1
},
"userLoginResultTypeName": {
"type": "string",
"example": "Login - Success"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2023-07-14T13:19:10.643Z"
},
"message": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "integer",
"example": 1
},
"message": {
"type": "string",
"example": "Login - Success"
}
},
"required": [
"code",
"message"
]
}
},
"sourceIPAddress": {
"type": "string",
"example": "127.0.0.1"
}
},
"required": [
"identity",
"userId",
"userName",
"userLoginResultTypeId",
"userLoginResultTypeName",
"date",
"message",
"sourceIPAddress"
]
}
}
}
}