POST api/invoiceEditList/GetBatches

Request Information

URI Parameters

None.

Body Parameters

InvBatchCriteria
NameDescriptionTypeAdditional information
LOCNCODE

string

None.

SearchValue

string

None.

IncludeReadyToPost

boolean

None.

IncludeHoldBatches

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "LOCNCODE": "sample string 1",
  "SearchValue": "sample string 2",
  "IncludeReadyToPost": true,
  "IncludeHoldBatches": true
}

application/xml, text/xml

Sample:
<InvBatchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <IncludeHoldBatches>true</IncludeHoldBatches>
  <IncludeReadyToPost>true</IncludeReadyToPost>
  <LOCNCODE>sample string 1</LOCNCODE>
  <SearchValue>sample string 2</SearchValue>
</InvBatchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of InvBatches
NameDescriptionTypeAdditional information
BACHNUMB

string

None.

LOCNCODE

string

None.

NumDocs

integer

None.

BatchTotal

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "BACHNUMB": "sample string 1",
    "LOCNCODE": "sample string 2",
    "NumDocs": 3,
    "BatchTotal": 4.1
  },
  {
    "BACHNUMB": "sample string 1",
    "LOCNCODE": "sample string 2",
    "NumDocs": 3,
    "BatchTotal": 4.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfInvBatches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <InvBatches>
    <BACHNUMB>sample string 1</BACHNUMB>
    <BatchTotal>4.1</BatchTotal>
    <LOCNCODE>sample string 2</LOCNCODE>
    <NumDocs>3</NumDocs>
  </InvBatches>
  <InvBatches>
    <BACHNUMB>sample string 1</BACHNUMB>
    <BatchTotal>4.1</BatchTotal>
    <LOCNCODE>sample string 2</LOCNCODE>
    <NumDocs>3</NumDocs>
  </InvBatches>
</ArrayOfInvBatches>