POST api/invoices/inquiry/export

Get the inquery result on a csv file in byte Array format

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ManagementCompanyIds	Collection of integer	None.
EntityId	integer	None.
PayeeName	string	None.
InvoiceId	integer	None.
InvoiceNumber	string	None.
InvoiceAmountFrom	decimal number	None.
InvoicesAmountTo	decimal number	None.
StatusIds	Collection of integer	None.
TypeIds	Collection of integer	None.
PaymentTypeIds	Collection of integer	None.
DateFrom	date	None.
DateTo	date	None.
GlDateFrom	date	None.
GlDateTo	date	None.
OrderBy	string	None.
OrderDesc	boolean	None.
PageSize	integer	None.
PageNumber	integer	None.
SortInformation	SortInformationViewModel	Required

Request Formats

application/json, text/json

Sample:

{
  "managementCompanyIds": [
    1,
    2
  ],
  "entityId": 1,
  "payeeName": "sample string 1",
  "invoiceId": 1,
  "invoiceNumber": "sample string 2",
  "invoiceAmountFrom": 1.0,
  "invoicesAmountTo": 1.0,
  "statusIds": [
    1,
    2
  ],
  "typeIds": [
    1,
    2
  ],
  "paymentTypeIds": [
    1,
    2
  ],
  "dateFrom": "2024-10-14T04:21:13.9539965-04:00",
  "dateTo": "2024-10-14T04:21:13.9539965-04:00",
  "glDateFrom": "2024-10-14T04:21:13.9539965-04:00",
  "glDateTo": "2024-10-14T04:21:13.9539965-04:00",
  "orderBy": "sample string 3",
  "orderDesc": true,
  "pageSize": 4,
  "pageNumber": 5,
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<InvoiceBatchInquiryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Invoices">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">5</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">4</PageSize>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <DateFrom>2024-10-14T04:21:13.9539965-04:00</DateFrom>
  <DateTo>2024-10-14T04:21:13.9539965-04:00</DateTo>
  <EntityId>1</EntityId>
  <GlDateFrom>2024-10-14T04:21:13.9539965-04:00</GlDateFrom>
  <GlDateTo>2024-10-14T04:21:13.9539965-04:00</GlDateTo>
  <InvoiceAmountFrom>1</InvoiceAmountFrom>
  <InvoiceId>1</InvoiceId>
  <InvoiceNumber>sample string 2</InvoiceNumber>
  <InvoicesAmountTo>1</InvoicesAmountTo>
  <ManagementCompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ManagementCompanyIds>
  <OrderBy>sample string 3</OrderBy>
  <OrderDesc>true</OrderDesc>
  <PayeeName>sample string 1</PayeeName>
  <PaymentTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PaymentTypeIds>
  <StatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StatusIds>
  <TypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TypeIds>
</InvoiceBatchInquiryViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceBatchInquiryViewModel'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.