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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class GetInvoicesByProjectRequest
            Public Overridable Property ProjectUID As Guid
        End Class

        Public Partial Class GetInvoicesByProjectResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Invoices As List(Of Invoice) = New List(Of Invoice)
            Public Overridable Property ProjectInvoiceData As ProjectInvoiceData
        End Class

        Public Partial Class Invoice
            Public Overridable Property InvoiceID As Integer
            Public Overridable Property InvoiceUID As Guid?
            Public Overridable Property ProjectUID As Guid?
            Public Overridable Property InvoiceNumber As String
            Public Overridable Property InvoiceDate As Date?
            Public Overridable Property DueDate As Date?
            Public Overridable Property FromName As String
            Public Overridable Property FromPhone As String
            Public Overridable Property FromEmail As String
            Public Overridable Property FromAddress As String
            Public Overridable Property FromDesc As String
            Public Overridable Property ToName As String
            Public Overridable Property ToPhone As String
            Public Overridable Property ToEmail As String
            Public Overridable Property ToAddress As String
            Public Overridable Property ToDesc As String
            Public Overridable Property Notes As String
            Public Overridable Property Currency As String
            Public Overridable Property Status As Integer
            Public Overridable Property Total As Decimal?
            Public Overridable Property IsPaid As Boolean?
            Public Overridable Property PaidDate As Date?
            Public Overridable Property IsDeleted As Boolean?
            Public Overridable Property IsLocked As Boolean?
            Public Overridable Property CreatedDate As Date?
            Public Overridable Property ModifiedDate As Date?
            Public Overridable Property CreatedByUID As Guid?
        End Class

        Public Partial Class ProjectInvoiceData
            Public Overridable Property InvoicedAmount As Decimal?
            Public Overridable Property PaidAmount As Decimal?
        End Class
    End Namespace
End Namespace

VB.NET 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>