POST CustomerStatement/Export

Export a customer statement as a PDF. This is sent as an application/octet-stream

Request Information

URI Parameters

None.

Body Parameters

CustomerStatementRequestModel

Name	Type	Additional information	Description
FromDate	date	None.	Gets or sets From Date.
ToDate	date	None.	Gets or sets To Date.
FromCustomer	string	None.	The Customer Name to start the range at.
ToCustomer	string	None.	The Customer Name to stop the range at.
FromCategory	string	None.	The Category Name to start the range at.
ToCategory	string	None.	The Category Name to stop the range at.
IncludeActive	bool	None.
IncludeInactive	bool	None.
CommunicationMethod	Communication Method Type	None.	Gets or sets the communication method. Optional. None = 0, Print = 1, Email = 2, Print and Email = 3 All = -1
ExcludeZeroBalanceAccounts	bool	None.
Detailed	bool	None.
ExcludeFullyAllocated	bool	None.
ShowBalanceBroughtForward	bool	None.
ExcludeNegativeBalance	bool	None.
UseMinimumBalance	bool	None.
MinimumBalance	decimal	None.
UseForeignCurrency	bool	None.

Request Formats

application/json, text/json

Sample:

{
  "FromCustomer": "sample string 1",
  "ToCustomer": "sample string 2",
  "FromCategory": "sample string 3",
  "ToCategory": "sample string 4",
  "IncludeActive": true,
  "IncludeInactive": true,
  "CommunicationMethod": 0,
  "ExcludeZeroBalanceAccounts": true,
  "Detailed": true,
  "ExcludeFullyAllocated": true,
  "ShowBalanceBroughtForward": true,
  "ExcludeNegativeBalance": true,
  "UseMinimumBalance": true,
  "MinimumBalance": 13.0,
  "UseForeignCurrency": true,
  "FromDate": "2024-11-15",
  "ToDate": "2024-11-15"
}

Response Information

Resource Description

PDF as application/octet-stream. If there is no valid statement to return, possibly due to an incorrect request model, a 204 status code will be returned.

Http Response Message

Name	Type	Additional information
Version	Version	None.
Content	Http Content	None.
StatusCode	Http Status Code	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	Http Request Message	None.
IsSuccessStatusCode	bool	None.