| POST | /api/invoice/search/sender | Search invoice based on search parameters |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.Invoice;
using DX.STF.Models.Queries.Invoice;
using DX.STF.Contracts.Enums;
using DX.STF.Models.Queries.QueryResult;
using DX.Framework.Core.Querying;
namespace DX.Framework.Core.Querying
{
public partial class PagedQueryResult<T>
{
public virtual long StartIndex { get; set; }
public virtual long EndIndex { get; set; }
public virtual int NumberOfRecordsReturned { get; set; }
public virtual int TotalNumberOfPages { get; set; }
public virtual long TotalNumberOfRecords { get; set; }
public virtual List<ResultItem<ClaimMessage>> Results { get; set; } = [];
}
}
namespace DX.STF.Application.ClientApi.Messages.Invoice
{
///<summary>
///Invoice
///</summary>
[Api(Description="Invoice")]
[ApiResponse(Description="Paged Purchase data", IsDefaultResponse=true, ResponseType=typeof(DX.STF.Models.Queries.QueryResult.PagedQueryResponseWithToken`1[[DX.Framework.Core.Querying.ResultItem`1[[DX.STF.Models.Dto.GS1.InvoiceMessage, DX.STF.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], DX.Framework.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)]
public partial class SearchSenderInvoice
{
///<summary>
///Search query
///</summary>
[ApiMember(Description="Search query", ParameterType="model")]
public virtual SearchInvoiceByDateFilter Query { get; set; }
}
}
namespace DX.STF.Contracts.Enums
{
public enum ORDER
{
ASC,
DESC,
}
}
namespace DX.STF.Models.Queries.Invoice
{
public partial class SearchInvoiceByDateFilter
: ISearchInvoiceByDateFilter
{
public virtual DateTime FromDate { get; set; }
public virtual DateTime ToDate { get; set; }
public virtual string ContinuationToken { get; set; }
public virtual int RequestedPage { get; set; }
public virtual int NumberOfRecordsPerPage { get; set; }
public virtual string OrderBy { get; set; }
public virtual ORDER Order { get; set; }
}
}
namespace DX.STF.Models.Queries.QueryResult
{
public partial class PagedQueryResponseWithToken<T>
: PagedQueryResult<ResultItem<InvoiceMessage>>
{
public virtual string ContinuationToken { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/invoice/search/sender HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"query":{"continuationToken":"String","requestedPage":0,"numberOfRecordsPerPage":0,"orderBy":"String","order":"ASC"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"continuationToken":"String","startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}