POST AcctReports/GetVolumeStatementReport

Generate a Volume Statement report

Request Information

URI Parameters

Body Parameters

The request object used to create report

VolumeStatementRequestBody
NameDescriptionTypeAdditional Information
CustomerGUID

Agvance Customer GUID

 globally unique identifier

Required
StartDate

Start Date

 date

Required
EndDate

End Date

 date

Required
TotalByDepartmentCategoryName

Total by the department category when true - if false, will total by department sales class

 boolean

Must be 0, 1, True, or False
LocationGuidForSalesTaxOverrideLabel

The location guid to use for determining the sales tax override heading. Used when UseCustomersLocationIdAsSalesTaxOverrideLocationId = false

 globally unique identifier

Only required when UseCustomersLocationIdAsSalesTaxOverrideLocationId = false. Default is null
UseCustomersLocationIdAsSalesTaxOverrideLocationId

Use the customer's location for the location to look up the sales tax override heading from

 boolean

Default value is true

Must be 0, 1, True, or False
IncludeGrainInformation

Include grain settlement in report. Minimum supported version is '6.0.16550'

 boolean

Must be 0, 1, True, or False
IncludeGrainAdvancePayments

Include Grain Advance payments

 boolean

Must be 0, 1, True, or False
IncludeDeferredPaymentAndInstallmentSales

Include Deferred Payments and Installment Sales in calculation

 boolean

Must be 0, 1, True, or False
UseGrossAmountOfDeferredPaymentAndInstallmentSales

Use gross amount of Deferred Payments and Installment Sales

 boolean

Must be 0, 1, True, or False
StatementMessage

Statement message to display on the report

 string

Max length: 200
FooterMessage

Footer message to display on the report

 string

Max length: 40
EligibleSettDedGuids

List of Eligible Settlement Deductions / Additions

 Collection of globally unique identifier
ServiceChargeSettDedGuids

List of Service Charge Settlement Deductions / Additions

 Collection of globally unique identifier

Request Formats

application/json, text/json

Sample: 
{
  "CustomerGUID": "7a05c10f-ffc0-4a8d-935c-1551589d6be1",
  "StartDate": "2025-11-28T17:58:41.0242434+00:00",
  "EndDate": "2025-11-28T17:58:41.0242434+00:00",
  "TotalByDepartmentCategoryName": true,
  "LocationGuidForSalesTaxOverrideLabel": "5bdab7b5-43f4-45dd-926a-c931cd0f5afc",
  "UseCustomersLocationIdAsSalesTaxOverrideLocationId": true,
  "IncludeGrainInformation": true,
  "IncludeGrainAdvancePayments": true,
  "IncludeDeferredPaymentAndInstallmentSales": true,
  "UseGrossAmountOfDeferredPaymentAndInstallmentSales": true,
  "StatementMessage": "sample string 9",
  "FooterMessage": "sample string 10",
  "EligibleSettDedGuids": [
    "ee27786c-b18b-42e9-8147-84d392425cba",
    "ee35813b-2284-4dc7-84e0-602b4ea10f49"
  ],
  "ServiceChargeSettDedGuids": [
    "fc3f8a31-fc63-4501-ad42-17436e96a085",
    "11d18247-569f-4033-a5cb-438e5a35ee58"
  ]
}

application/xml, text/xml

Sample: 
<VolumeStatementRequestBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.ApiReports">
  <CustomerGUID>7a05c10f-ffc0-4a8d-935c-1551589d6be1</CustomerGUID>
  <EligibleSettDedGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>ee27786c-b18b-42e9-8147-84d392425cba</d2p1:guid>
    <d2p1:guid>ee35813b-2284-4dc7-84e0-602b4ea10f49</d2p1:guid>
  </EligibleSettDedGuids>
  <EndDate>2025-11-28T17:58:41.0242434+00:00</EndDate>
  <FooterMessage>sample string 10</FooterMessage>
  <IncludeDeferredPaymentAndInstallmentSales>true</IncludeDeferredPaymentAndInstallmentSales>
  <IncludeGrainAdvancePayments>true</IncludeGrainAdvancePayments>
  <IncludeGrainInformation>true</IncludeGrainInformation>
  <LocationGuidForSalesTaxOverrideLabel>5bdab7b5-43f4-45dd-926a-c931cd0f5afc</LocationGuidForSalesTaxOverrideLabel>
  <ServiceChargeSettDedGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>fc3f8a31-fc63-4501-ad42-17436e96a085</d2p1:guid>
    <d2p1:guid>11d18247-569f-4033-a5cb-438e5a35ee58</d2p1:guid>
  </ServiceChargeSettDedGuids>
  <StartDate>2025-11-28T17:58:41.0242434+00:00</StartDate>
  <StatementMessage>sample string 9</StatementMessage>
  <TotalByDepartmentCategoryName>true</TotalByDepartmentCategoryName>
  <UseCustomersLocationIdAsSalesTaxOverrideLocationId>true</UseCustomersLocationIdAsSalesTaxOverrideLocationId>
  <UseGrossAmountOfDeferredPaymentAndInstallmentSales>true</UseGrossAmountOfDeferredPaymentAndInstallmentSales>
</VolumeStatementRequestBody>

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 'VolumeStatementRequestBody'.

Response Information

Resource Description

Generate a Volume Statement report

AgvAccountingReport
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of errors from the API

 Collection of string
WarningList

List of warnings from the API

 Collection of string
S3FileName

The S3 file that was generated for the requested report

 string

Will be "null" when the status is not success.
PreSignedUrl

The presigned url of the file

 string

Will be "null" when the S3FileName is not populated.

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "S3FileName": "sample string 3",
  "PreSignedUrl": "sample string 4"
}

application/xml, text/xml

Sample: 
<AgvAccountingReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.AcctReports">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <PreSignedUrl>sample string 4</PreSignedUrl>
  <S3FileName>sample string 3</S3FileName>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvAccountingReport>