regis

<back to all web services

FinanceOverallBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/Overall

export class FinanceOverallBalanceResponse
{
    public responseStatus: ResponseStatus;
    public balance: number;
    public posted_sales: number;
    public unposted_sales: number;
    public payments: number;

    public constructor(init?: Partial<FinanceOverallBalanceResponse>) { (Object as any).assign(this, init); }
}

export class FinanceOverallBalanceRequest
{

    public constructor(init?: Partial<FinanceOverallBalanceRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinanceOverallBalanceRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/Balance/Overall HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"balance":0,"posted_sales":0,"unposted_sales":0,"payments":0}