Trendsic Platform Service

<back to all web services

InvoiceGenerateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate}

export class InvoiceLineItem
{
    public InvoiceLineItemID: number;
    public InvoiceID: number;
    public Type: string;
    public Name: string;
    public Quantity?: number;
    public PercentageAdjust?: number;
    public AmountAdjust?: number;
    public Price?: number;
    public Description: string;
    public Notes: string;
    public IsTaxable?: boolean;
    public DisplayOrder?: number;
    public IsLocked?: boolean;
    public IsDeleted?: boolean;
    public IsPaid?: boolean;
    public CreatedDate?: string;
    public ModifiedDate?: string;
    public CreatedByUID?: string;

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

export class InvoiceGenerateResponse
{
    public ResponseStatus: ResponseStatus;
    public ProjectInvoice: InvoiceLineItem[] = [];

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

export class InvoiceGenerateRequest
{
    public ProjectUID: string;
    public InvoiceStartDate: string;
    public InvoiceEndDate: string;

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

TypeScript InvoiceGenerateRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectInvoice":[{"InvoiceLineItemID":0,"InvoiceID":0,"Type":"String","Name":"String","Quantity":0,"PercentageAdjust":0,"AmountAdjust":0,"Price":0,"Description":"String","Notes":"String","IsTaxable":false,"DisplayOrder":0,"IsLocked":false,"IsDeleted":false,"IsPaid":false,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}]}