Trendsic Platform Service

<back to all web services

GetInvoiceByUidRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/invoice/{InvoiceUID}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class GetInvoiceByUidRequest
    {
        public virtual Guid InvoiceUID { get; set; }
    }

    public partial class GetInvoiceByUidResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual InvoiceData InvoiceData { get; set; }
    }

    public partial class Invoice
    {
        public virtual int InvoiceID { get; set; }
        public virtual Guid? InvoiceUID { get; set; }
        public virtual Guid? ProjectUID { get; set; }
        public virtual string InvoiceNumber { get; set; }
        public virtual DateTime? InvoiceDate { get; set; }
        public virtual DateTime? DueDate { get; set; }
        public virtual string FromName { get; set; }
        public virtual string FromPhone { get; set; }
        public virtual string FromEmail { get; set; }
        public virtual string FromAddress { get; set; }
        public virtual string FromDesc { get; set; }
        public virtual string ToName { get; set; }
        public virtual string ToPhone { get; set; }
        public virtual string ToEmail { get; set; }
        public virtual string ToAddress { get; set; }
        public virtual string ToDesc { get; set; }
        public virtual string Notes { get; set; }
        public virtual string Currency { get; set; }
        public virtual int Status { get; set; }
        public virtual decimal? Total { get; set; }
        public virtual bool? IsPaid { get; set; }
        public virtual DateTime? PaidDate { get; set; }
        public virtual bool? IsDeleted { get; set; }
        public virtual bool? IsLocked { get; set; }
        public virtual DateTime? CreatedDate { get; set; }
        public virtual DateTime? ModifiedDate { get; set; }
        public virtual Guid? CreatedByUID { get; set; }
    }

    public partial class InvoiceData
    {
        public virtual Invoice Invoice { get; set; }
        public virtual List<InvoiceLineItem> LineItems { get; set; } = [];
    }

    public partial class InvoiceLineItem
    {
        public virtual int InvoiceLineItemID { get; set; }
        public virtual int InvoiceID { get; set; }
        public virtual string Type { get; set; }
        public virtual string Name { get; set; }
        public virtual int? Quantity { get; set; }
        public virtual decimal? PercentageAdjust { get; set; }
        public virtual decimal? AmountAdjust { get; set; }
        public virtual decimal? Price { get; set; }
        public virtual string Description { get; set; }
        public virtual string Notes { get; set; }
        public virtual bool? IsTaxable { get; set; }
        public virtual int? DisplayOrder { get; set; }
        public virtual bool? IsLocked { get; set; }
        public virtual bool? IsDeleted { get; set; }
        public virtual bool? IsPaid { get; set; }
        public virtual DateTime? CreatedDate { get; set; }
        public virtual DateTime? ModifiedDate { get; set; }
        public virtual Guid? CreatedByUID { get; set; }
    }

}

C# GetInvoiceByUidRequest 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.

GET /v1/invoice/{InvoiceUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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"}},"InvoiceData":{"Invoice":{"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"},"LineItems":[{"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"}]}}