POST API/Budget/LoadBudgetCategoryDetail

Request Information

URI Parameters

None.

Body Parameters

LoadBudgetCategoryRequest
NameDescriptionTypeAdditional information
CategoryID

integer

None.

Token

string

None.

ValidationMessage

string

None.

ErrorCode

ErrorCodes

None.

Request Formats

application/json, text/json

Sample:
{
  "CategoryID": 1,
  "Token": "sample string 2",
  "ValidationMessage": "sample string 3",
  "ErrorCode": 101
}

application/xml, text/xml

Sample:
<LoadBudgetCategoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models">
  <Token>sample string 2</Token>
  <CategoryID>1</CategoryID>
</LoadBudgetCategoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BudgetCategoryDetailResponse
NameDescriptionTypeAdditional information
Category

BudgetCategoryDetail

None.

AccountType

string

None.

ActiveAccount

boolean

None.

ExpirationDate

date

None.

CustomerMessage

CustomerMessage

None.

Success

boolean

None.

ErrorCode

ErrorCodes

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Category": {
    "ID": 1,
    "Name": "sample string 2",
    "Amount": 3.1,
    "AmountSpent": 4.1,
    "Expenses": [
      {
        "ID": 1,
        "DateSpent": "2025-12-09T21:21:39.6139842+00:00",
        "Amount": 3.1,
        "Merchant": "sample string 4",
        "Note": "sample string 5"
      },
      {
        "ID": 1,
        "DateSpent": "2025-12-09T21:21:39.6139842+00:00",
        "Amount": 3.1,
        "Merchant": "sample string 4",
        "Note": "sample string 5"
      }
    ]
  },
  "AccountType": "sample string 1",
  "ActiveAccount": true,
  "ExpirationDate": "2025-12-09T21:21:39.6139842+00:00",
  "CustomerMessage": {
    "Cheer": {
      "Message": "sample string 1"
    },
    "Advertisement": {
      "ID": 1,
      "ImageURL": "sample string 2",
      "DestinationURL": "sample string 3",
      "BackgroundColor": "sample string 4",
      "Sequence": 5,
      "IsNotification": true,
      "DisplayID": 7
    }
  },
  "Success": true,
  "ErrorCode": 101,
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<BudgetCategoryDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models">
  <ErrorCode>InvalidToken</ErrorCode>
  <Message>sample string 4</Message>
  <Success>true</Success>
  <AccountType>sample string 1</AccountType>
  <ActiveAccount>true</ActiveAccount>
  <CustomerMessage>
    <Advertisement>
      <BackgroundColor>sample string 4</BackgroundColor>
      <DestinationURL>sample string 3</DestinationURL>
      <DisplayID>7</DisplayID>
      <ID>1</ID>
      <ImageURL>sample string 2</ImageURL>
      <IsNotification>true</IsNotification>
      <Sequence>5</Sequence>
    </Advertisement>
    <Cheer>
      <Message>sample string 1</Message>
    </Cheer>
  </CustomerMessage>
  <ExpirationDate>2025-12-09T21:21:39.6139842+00:00</ExpirationDate>
  <Category>
    <Amount>3.1</Amount>
    <AmountSpent>4.1</AmountSpent>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <Expenses>
      <Expense>
        <Amount>3.1</Amount>
        <DateSpent>2025-12-09T21:21:39.6139842+00:00</DateSpent>
        <ID>1</ID>
        <Merchant>sample string 4</Merchant>
        <Note>sample string 5</Note>
      </Expense>
      <Expense>
        <Amount>3.1</Amount>
        <DateSpent>2025-12-09T21:21:39.6139842+00:00</DateSpent>
        <ID>1</ID>
        <Merchant>sample string 4</Merchant>
        <Note>sample string 5</Note>
      </Expense>
    </Expenses>
  </Category>
</BudgetCategoryDetailResponse>