Trendsic Platform Service

<back to all web services

InvoiceGenerateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/invoice/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate}
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 InvoiceGenerateRequest
            Public Overridable Property ProjectUID As Guid
            Public Overridable Property InvoiceStartDate As Date
            Public Overridable Property InvoiceEndDate As Date
        End Class

        Public Partial Class InvoiceGenerateResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ProjectInvoice As List(Of InvoiceLineItem) = New List(Of InvoiceLineItem)
        End Class

        Public Partial Class InvoiceLineItem
            Public Overridable Property InvoiceLineItemID As Integer
            Public Overridable Property InvoiceID As Integer
            Public Overridable Property Type As String
            Public Overridable Property Name As String
            Public Overridable Property Quantity As Integer?
            Public Overridable Property PercentageAdjust As Decimal?
            Public Overridable Property AmountAdjust As Decimal?
            Public Overridable Property Price As Decimal?
            Public Overridable Property Description As String
            Public Overridable Property Notes As String
            Public Overridable Property IsTaxable As Boolean?
            Public Overridable Property DisplayOrder As Integer?
            Public Overridable Property IsLocked As Boolean?
            Public Overridable Property IsDeleted As Boolean?
            Public Overridable Property IsPaid As Boolean?
            Public Overridable Property CreatedDate As Date?
            Public Overridable Property ModifiedDate As Date?
            Public Overridable Property CreatedByUID As Guid?
        End Class
    End Namespace
End Namespace

VB.NET InvoiceGenerateRequest 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/generate/{ProjectUID}/{InvoiceStartDate}/{InvoiceEndDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceGenerateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectInvoice>
    <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>
  </ProjectInvoice>
  <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>
</InvoiceGenerateResponse>