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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetInvoicesByProjectRequest
{
    open var ProjectUID:UUID? = null
}

open class GetInvoicesByProjectResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Invoices:ArrayList<Invoice> = ArrayList<Invoice>()
    open var ProjectInvoiceData:ProjectInvoiceData? = null
}

open class Invoice
{
    open var InvoiceID:Int? = null
    open var InvoiceUID:UUID? = null
    open var ProjectUID:UUID? = null
    open var InvoiceNumber:String? = null
    open var InvoiceDate:Date? = null
    open var DueDate:Date? = null
    open var FromName:String? = null
    open var FromPhone:String? = null
    open var FromEmail:String? = null
    open var FromAddress:String? = null
    open var FromDesc:String? = null
    open var ToName:String? = null
    open var ToPhone:String? = null
    open var ToEmail:String? = null
    open var ToAddress:String? = null
    open var ToDesc:String? = null
    open var Notes:String? = null
    open var Currency:String? = null
    open var Status:Int? = null
    open var Total:BigDecimal? = null
    open var IsPaid:Boolean? = null
    open var PaidDate:Date? = null
    open var IsDeleted:Boolean? = null
    open var IsLocked:Boolean? = null
    open var CreatedDate:Date? = null
    open var ModifiedDate:Date? = null
    open var CreatedByUID:UUID? = null
}

open class ProjectInvoiceData
{
    open var InvoicedAmount:BigDecimal? = null
    open var PaidAmount:BigDecimal? = null
}

Kotlin GetInvoicesByProjectRequest 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/project/{ProjectUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInvoicesByProjectResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Invoices>
    <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>
  </Invoices>
  <ProjectInvoiceData>
    <InvoicedAmount>0</InvoicedAmount>
    <PaidAmount>0</PaidAmount>
  </ProjectInvoiceData>
  <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>
</GetInvoicesByProjectResponse>