POST v1/LedgerAccounts

Description

Add a new Ledger account.

Base Url

https://api-agc.wsohosting.com/


Rest Call Syntax


POST CashManagement/v1/LedgerAccounts

POST CashManagement/v1/LedgerAccounts

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



LedgerAccountAdd

Name

Description

Type

Additional Information

AccountName

The name of the ledger account.

string

AccountNumber

Account number

string

AccountType

BaseCurrencyCode

Currency type

string

CountryId

Country id

integer

CustodianId

CustodianId

integer

Description

Description

string

Notes

Notes

string

PortfolioOverride

Porftfolio override

integer




Limitations

There are no limitations specified.




Request Information


Request body formats


application/json, text/json

Sample:
{
  "accountName": "sample string 1",
  "accountNumber": "sample string 2",
  "notes": "sample string 3",
  "accountType": "General",
  "baseCurrencyCode": "sample string 4",
  "description": "sample string 5",
  "portfolioOverride": 6,
  "countryId": 7,
  "custodianId": 8
}

application/xml, text/xml

Sample:
<LedgerAccountAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountName>sample string 1</AccountName>
  <AccountNumber>sample string 2</AccountNumber>
  <AccountType>General</AccountType>
  <BaseCurrencyCode>sample string 4</BaseCurrencyCode>
  <CountryId>7</CountryId>
  <CustodianId>8</CustodianId>
  <Description>sample string 5</Description>
  <Notes>sample string 3</Notes>
  <PortfolioOverride>6</PortfolioOverride>
</LedgerAccountAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



LedgerAccount

Name

Description

Type

Additional Information

AccountNumber

Account number.

string

AccountType

Account type.

string

AddDate

Add date

date

AddId

Add id

string

AddNode

Add node

string

CompanyId

Company id

integer

Country

Country link

CountryId

Country id.

integer

CurrencyType

Currency type

string

Custodian

Custodian Link

CustodianId

Custodian id.

integer

Description

string

Id

integer

IsDeleted

Delete status of this item.

boolean

LastChangeDate

Last change date.

date

LastChangeId

last change id

string

LastChangeNode

last change node.

string

LedgerAccountName

string

Links

The Hateoas links related to this ledger account

Collection of Link

Notes

Notes

string

PortfolioOverride

integer

Udfs

Link to Udfs




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "ledgerAccountName": "sample string 2",
  "isDeleted": true,
  "accountNumber": "sample string 5",
  "notes": "sample string 6",
  "accountType": "sample string 7",
  "currencyType": "sample string 8",
  "description": "sample string 9",
  "portfolioOverride": 10,
  "companyId": 1,
  "country": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "countryId": 11,
  "custodian": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "custodianId": 12,
  "addDate": "2024-10-08T05:31:41.1918552-05:00",
  "addId": "sample string 14",
  "addNode": "sample string 15",
  "lastChangeDate": "2024-10-08T05:31:41.1918552-05:00",
  "lastChangeId": "sample string 17",
  "lastChangeNode": "sample string 18",
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ],
  "udfs": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  }
}

application/xml, text/xml

Sample:
<LedgerAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountNumber>sample string 5</AccountNumber>
  <AccountType>sample string 7</AccountType>
  <AddDate>2024-10-08T05:31:41.1918552-05:00</AddDate>
  <AddId>sample string 14</AddId>
  <AddNode>sample string 15</AddNode>
  <CompanyId>1</CompanyId>
  <Country>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Country>
  <CountryId>11</CountryId>
  <CurrencyType>sample string 8</CurrencyType>
  <Custodian>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Custodian>
  <CustodianId>12</CustodianId>
  <Description>sample string 9</Description>
  <Id>1</Id>
  <IsDeleted>true</IsDeleted>
  <LastChangeDate>2024-10-08T05:31:41.1918552-05:00</LastChangeDate>
  <LastChangeId>sample string 17</LastChangeId>
  <LastChangeNode>sample string 18</LastChangeNode>
  <LedgerAccountName>sample string 2</LedgerAccountName>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <Notes>sample string 6</Notes>
  <PortfolioOverride>10</PortfolioOverride>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
</LedgerAccount>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.