Trendsic Platform Service

<back to all web services

PortalInvoiceRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/invoice
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class InvoiceLineItem
    {
        public virtual int InvoiceLineItemID { get; set; }
        public virtual int InvoiceID { get; set; }
        public virtual string Type { get; set; }
        public virtual string Name { get; set; }
        public virtual int? Quantity { get; set; }
        public virtual decimal? PercentageAdjust { get; set; }
        public virtual decimal? AmountAdjust { get; set; }
        public virtual decimal? Price { get; set; }
        public virtual string Description { get; set; }
        public virtual string Notes { get; set; }
        public virtual bool? IsTaxable { get; set; }
        public virtual int? DisplayOrder { get; set; }
        public virtual bool? IsLocked { get; set; }
        public virtual bool? IsDeleted { get; set; }
        public virtual bool? IsPaid { get; set; }
        public virtual DateTime? CreatedDate { get; set; }
        public virtual DateTime? ModifiedDate { get; set; }
        public virtual Guid? CreatedByUID { get; set; }
    }

    public partial class PortalInvoiceRequest
    {
        public virtual string Token { get; set; }
    }

    public partial class PortalInvoiceResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string InvoiceNumber { get; set; }
        public virtual DateTime? InvoiceDate { get; set; }
        public virtual DateTime? DueDate { get; set; }
        public virtual string FromName { get; set; }
        public virtual string FromAddress { get; set; }
        public virtual string ToName { get; set; }
        public virtual string ToAddress { get; set; }
        public virtual string Currency { get; set; }
        public virtual decimal Total { get; set; }
        public virtual decimal AmountPaid { get; set; }
        public virtual decimal Balance { get; set; }
        public virtual bool IsPaid { get; set; }
        public virtual List<InvoiceLineItem> LineItems { get; set; } = [];
    }

}

C# 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>