BokaMera.API.Host

<back to all web services

GetVossCustomerInvoiceBalance

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/voss/invoice/balanceget voss invoice

export enum SortDirectionEnum
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class VossPagination
{
    public SearchText?: string;
    public PageIndex: number;
    public PageSize: number;
    public SortField?: string;
    public SortDirection: SortDirectionEnum;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class GetVossCustomerInvoiceBalance extends VossPagination
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead */
    // @ApiMember(Description="Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead")
    public InvoiceDate?: string;

    /** @description If present the operation will start only after this date */
    // @ApiMember(Description="If present the operation will start only after this date")
    public ScheduledStartTime?: string;

    /** @description Optional CRON expression for recurring operations. */
    // @ApiMember(Description="Optional CRON expression for recurring operations.")
    public RecurringSchedule: string;

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

TypeScript GetVossCustomerInvoiceBalance DTOs

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

HTTP + JSV

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

GET /voss/invoice/balance HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}