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}
"use strict";
export class GetInvoiceByUidRequest {
    /** @param {{InvoiceUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InvoiceUID;
}
export class Invoice {
    /** @param {{InvoiceID?:number,InvoiceUID?:string,ProjectUID?:string,InvoiceNumber?:string,InvoiceDate?:string,DueDate?:string,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?:number,Total?:number,IsPaid?:boolean,PaidDate?:string,IsDeleted?:boolean,IsLocked?:boolean,CreatedDate?:string,ModifiedDate?:string,CreatedByUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    InvoiceID;
    /** @type {?string} */
    InvoiceUID;
    /** @type {?string} */
    ProjectUID;
    /** @type {string} */
    InvoiceNumber;
    /** @type {?string} */
    InvoiceDate;
    /** @type {?string} */
    DueDate;
    /** @type {string} */
    FromName;
    /** @type {string} */
    FromPhone;
    /** @type {string} */
    FromEmail;
    /** @type {string} */
    FromAddress;
    /** @type {string} */
    FromDesc;
    /** @type {string} */
    ToName;
    /** @type {string} */
    ToPhone;
    /** @type {string} */
    ToEmail;
    /** @type {string} */
    ToAddress;
    /** @type {string} */
    ToDesc;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Currency;
    /** @type {number} */
    Status;
    /** @type {?number} */
    Total;
    /** @type {?boolean} */
    IsPaid;
    /** @type {?string} */
    PaidDate;
    /** @type {?boolean} */
    IsDeleted;
    /** @type {?boolean} */
    IsLocked;
    /** @type {?string} */
    CreatedDate;
    /** @type {?string} */
    ModifiedDate;
    /** @type {?string} */
    CreatedByUID;
}
export class InvoiceLineItem {
    /** @param {{InvoiceLineItemID?:number,InvoiceID?:number,Type?:string,Name?:string,Quantity?:number,PercentageAdjust?:number,AmountAdjust?:number,Price?:number,Description?:string,Notes?:string,IsTaxable?:boolean,DisplayOrder?:number,IsLocked?:boolean,IsDeleted?:boolean,IsPaid?:boolean,CreatedDate?:string,ModifiedDate?:string,CreatedByUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    InvoiceLineItemID;
    /** @type {number} */
    InvoiceID;
    /** @type {string} */
    Type;
    /** @type {string} */
    Name;
    /** @type {?number} */
    Quantity;
    /** @type {?number} */
    PercentageAdjust;
    /** @type {?number} */
    AmountAdjust;
    /** @type {?number} */
    Price;
    /** @type {string} */
    Description;
    /** @type {string} */
    Notes;
    /** @type {?boolean} */
    IsTaxable;
    /** @type {?number} */
    DisplayOrder;
    /** @type {?boolean} */
    IsLocked;
    /** @type {?boolean} */
    IsDeleted;
    /** @type {?boolean} */
    IsPaid;
    /** @type {?string} */
    CreatedDate;
    /** @type {?string} */
    ModifiedDate;
    /** @type {?string} */
    CreatedByUID;
}
export class InvoiceData {
    /** @param {{Invoice?:Invoice,LineItems?:InvoiceLineItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Invoice} */
    Invoice;
    /** @type {InvoiceLineItem[]} */
    LineItems = [];
}
export class GetInvoiceByUidResponse {
    /** @param {{ResponseStatus?:ResponseStatus,InvoiceData?:InvoiceData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {InvoiceData} */
    InvoiceData;
}

JavaScript 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>