Trendsic Platform Service

<back to all web services

PortalInvoiceRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/invoice
import Foundation
import ServiceStack

public class PortalInvoiceRequest : Codable
{
    public var token:String

    required public init(){}
}

public class PortalInvoiceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var invoiceNumber:String
    public var invoiceDate:Date?
    public var dueDate:Date?
    public var fromName:String
    public var fromAddress:String
    public var toName:String
    public var toAddress:String
    public var currency:String
    public var total:Double
    public var amountPaid:Double
    public var balance:Double
    public var isPaid:Bool
    public var lineItems:[InvoiceLineItem] = []

    required public init(){}
}

public class InvoiceLineItem : Codable
{
    public var invoiceLineItemID:Int
    public var invoiceID:Int
    public var type:String
    public var name:String
    public var quantity:Int?
    public var percentageAdjust:Double?
    public var amountAdjust:Double?
    public var price:Double?
    public var Description:String
    public var notes:String
    public var isTaxable:Bool?
    public var displayOrder:Int?
    public var isLocked:Bool?
    public var isDeleted:Bool?
    public var isPaid:Bool?
    public var createdDate:Date?
    public var modifiedDate:Date?
    public var createdByUID:String?

    required public init(){}
}


Swift PortalInvoiceRequest 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 /portal/{Token}/invoice HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PortalInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AmountPaid>0</AmountPaid>
  <Balance>0</Balance>
  <Currency>String</Currency>
  <DueDate>0001-01-01T00:00:00</DueDate>
  <FromAddress>String</FromAddress>
  <FromName>String</FromName>
  <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
  <InvoiceNumber>String</InvoiceNumber>
  <IsPaid>false</IsPaid>
  <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>
  <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>
  <ToAddress>String</ToAddress>
  <ToName>String</ToName>
  <Total>0</Total>
</PortalInvoiceResponse>