| Requires any of the roles: | Agent, Administrator |
| PUT,OPTIONS | /v1/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 Invoice
{
public virtual int InvoiceID { get; set; }
public virtual Guid? InvoiceUID { get; set; }
public virtual Guid? ProjectUID { 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 FromPhone { get; set; }
public virtual string FromEmail { get; set; }
public virtual string FromAddress { get; set; }
public virtual string FromDesc { get; set; }
public virtual string ToName { get; set; }
public virtual string ToPhone { get; set; }
public virtual string ToEmail { get; set; }
public virtual string ToAddress { get; set; }
public virtual string ToDesc { get; set; }
public virtual string Notes { get; set; }
public virtual string Currency { get; set; }
public virtual int Status { get; set; }
public virtual decimal? Total { get; set; }
public virtual bool? IsPaid { get; set; }
public virtual DateTime? PaidDate { get; set; }
public virtual bool? IsDeleted { get; set; }
public virtual bool? IsLocked { get; set; }
public virtual DateTime? CreatedDate { get; set; }
public virtual DateTime? ModifiedDate { get; set; }
public virtual Guid? CreatedByUID { get; set; }
}
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 UpdateInvoiceRequest
{
public virtual Invoice Invoice { get; set; }
public virtual List<InvoiceLineItem> LineItems { get; set; } = [];
}
public partial class UpdateInvoiceResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual bool Success { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/invoice HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<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>
</UpdateInvoiceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Success>false</Success>
</UpdateInvoiceResponse>