Trendsic Platform Service

GetInvoiceByUidRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/invoice/{InvoiceUID}


export class GetInvoiceByUidRequest
{
    public InvoiceUID: string;

    public constructor(init?: Partial<GetInvoiceByUidRequest>) { (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 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 InvoiceData
{
    public Invoice: Invoice;
    public LineItems: InvoiceLineItem[] = [];

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

export class GetInvoiceByUidResponse
{
    public ResponseStatus: ResponseStatus;
    public InvoiceData: InvoiceData;

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

TypeScript GetInvoiceByUidRequest DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInvoiceByUidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <InvoiceData>
    <Invoice>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Currency>String</Currency>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <FromAddress>String</FromAddress>
      <FromDesc>String</FromDesc>
      <FromEmail>String</FromEmail>
      <FromName>String</FromName>
      <FromPhone>String</FromPhone>
      <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
      <InvoiceID>0</InvoiceID>
      <InvoiceNumber>String</InvoiceNumber>
      <InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
      <IsDeleted>false</IsDeleted>
      <IsLocked>false</IsLocked>
      <IsPaid>false</IsPaid>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <Notes>String</Notes>
      <PaidDate>0001-01-01T00:00:00</PaidDate>
      <ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
      <Status>0</Status>
      <ToAddress>String</ToAddress>
      <ToDesc>String</ToDesc>
      <ToEmail>String</ToEmail>
      <ToName>String</ToName>
      <ToPhone>String</ToPhone>
      <Total>0</Total>
    </Invoice>
    <LineItems>
      <InvoiceLineItem>
        <AmountAdjust>0</AmountAdjust>
        <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <Description>String</Description>
        <DisplayOrder>0</DisplayOrder>
        <InvoiceID>0</InvoiceID>
        <InvoiceLineItemID>0</InvoiceLineItemID>
        <IsDeleted>false</IsDeleted>
        <IsLocked>false</IsLocked>
        <IsPaid>false</IsPaid>
        <IsTaxable>false</IsTaxable>
        <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
        <Name>String</Name>
        <Notes>String</Notes>
        <PercentageAdjust>0</PercentageAdjust>
        <Price>0</Price>
        <Quantity>0</Quantity>
        <Type>String</Type>
      </InvoiceLineItem>
    </LineItems>
  </InvoiceData>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetInvoiceByUidResponse>