Trendsic Platform Service

<back to all web services

GetInvoicesByProjectRequest

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

export class GetInvoicesByProjectRequest
{
    public ProjectUID: string;

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

export class Invoice
{
    public InvoiceID: number;
    public InvoiceUID?: string;
    public ProjectUID?: string;
    public InvoiceNumber: string;
    public InvoiceDate?: string;
    public DueDate?: string;
    public FromName: string;
    public FromPhone: string;
    public FromEmail: string;
    public FromAddress: string;
    public FromDesc: string;
    public ToName: string;
    public ToPhone: string;
    public ToEmail: string;
    public ToAddress: string;
    public ToDesc: string;
    public Notes: string;
    public Currency: string;
    public Status: number;
    public Total?: number;
    public IsPaid?: boolean;
    public PaidDate?: string;
    public IsDeleted?: boolean;
    public IsLocked?: boolean;
    public CreatedDate?: string;
    public ModifiedDate?: string;
    public CreatedByUID?: string;

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

export class ProjectInvoiceData
{
    public InvoicedAmount?: number;
    public PaidAmount?: number;

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

export class GetInvoicesByProjectResponse
{
    public ResponseStatus: ResponseStatus;
    public Invoices: Invoice[] = [];
    public ProjectInvoiceData: ProjectInvoiceData;

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

TypeScript GetInvoicesByProjectRequest 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/project/{ProjectUID} 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"}},"Invoices":[{"InvoiceID":0,"InvoiceUID":"00000000000000000000000000000000","ProjectUID":"00000000000000000000000000000000","InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","FromName":"String","FromPhone":"String","FromEmail":"String","FromAddress":"String","FromDesc":"String","ToName":"String","ToPhone":"String","ToEmail":"String","ToAddress":"String","ToDesc":"String","Notes":"String","Currency":"String","Status":0,"Total":0,"IsPaid":false,"PaidDate":"0001-01-01T00:00:00.0000000","IsDeleted":false,"IsLocked":false,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000"}],"ProjectInvoiceData":{"InvoicedAmount":0,"PaidAmount":0}}