POST api/toolchest/GetBcApHeldDocs
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of BcApHeldDoc| Name | Description | Type | Additional information |
|---|---|---|---|
| BcInvoiceId | string |
None. |
|
| BcInvoiceNumber | string |
None. |
|
| VendorDocNumber | string |
None. |
|
| DocType | string |
None. |
|
| CompanyId | string |
None. |
|
| VendorId | string |
None. |
|
| HeldReason | string |
None. |
|
| DownloadRunId | string |
None. |
|
| DownloadedDateTime | date |
None. |
|
| RetryCount | integer |
None. |
|
| LastRetriedDateTime | date |
None. |
|
| Details | Collection of BcApHeldDetail |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"HeldReason": "sample string 7",
"DownloadRunId": "sample string 8",
"DownloadedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"RetryCount": 9,
"LastRetriedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"Details": [
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"DownloadRunId": "sample string 7",
"AttemptNumber": 8,
"CreatedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"FailureCategory": "sample string 9",
"BcNatural": "sample string 10",
"Site": "sample string 11",
"Dept": "sample string 12",
"RawDims": "sample string 13",
"LineAmount": 1.0,
"ResolvedGpAccount": "sample string 14",
"DocTotal": 1.0
},
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"DownloadRunId": "sample string 7",
"AttemptNumber": 8,
"CreatedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"FailureCategory": "sample string 9",
"BcNatural": "sample string 10",
"Site": "sample string 11",
"Dept": "sample string 12",
"RawDims": "sample string 13",
"LineAmount": 1.0,
"ResolvedGpAccount": "sample string 14",
"DocTotal": 1.0
}
]
},
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"HeldReason": "sample string 7",
"DownloadRunId": "sample string 8",
"DownloadedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"RetryCount": 9,
"LastRetriedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"Details": [
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"DownloadRunId": "sample string 7",
"AttemptNumber": 8,
"CreatedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"FailureCategory": "sample string 9",
"BcNatural": "sample string 10",
"Site": "sample string 11",
"Dept": "sample string 12",
"RawDims": "sample string 13",
"LineAmount": 1.0,
"ResolvedGpAccount": "sample string 14",
"DocTotal": 1.0
},
{
"BcInvoiceId": "sample string 1",
"BcInvoiceNumber": "sample string 2",
"VendorDocNumber": "sample string 3",
"DocType": "sample string 4",
"CompanyId": "sample string 5",
"VendorId": "sample string 6",
"DownloadRunId": "sample string 7",
"AttemptNumber": 8,
"CreatedDateTime": "2026-11-21T05:35:42.7073765+00:00",
"FailureCategory": "sample string 9",
"BcNatural": "sample string 10",
"Site": "sample string 11",
"Dept": "sample string 12",
"RawDims": "sample string 13",
"LineAmount": 1.0,
"ResolvedGpAccount": "sample string 14",
"DocTotal": 1.0
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfBcApHeldDoc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<BcApHeldDoc>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<CompanyId>sample string 5</CompanyId>
<Details>
<BcApHeldDetail>
<AttemptNumber>8</AttemptNumber>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<BcNatural>sample string 10</BcNatural>
<CompanyId>sample string 5</CompanyId>
<CreatedDateTime>2026-11-21T05:35:42.7073765+00:00</CreatedDateTime>
<Dept>sample string 12</Dept>
<DocTotal>1</DocTotal>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 7</DownloadRunId>
<FailureCategory>sample string 9</FailureCategory>
<LineAmount>1</LineAmount>
<RawDims>sample string 13</RawDims>
<ResolvedGpAccount>sample string 14</ResolvedGpAccount>
<Site>sample string 11</Site>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDetail>
<BcApHeldDetail>
<AttemptNumber>8</AttemptNumber>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<BcNatural>sample string 10</BcNatural>
<CompanyId>sample string 5</CompanyId>
<CreatedDateTime>2026-11-21T05:35:42.7073765+00:00</CreatedDateTime>
<Dept>sample string 12</Dept>
<DocTotal>1</DocTotal>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 7</DownloadRunId>
<FailureCategory>sample string 9</FailureCategory>
<LineAmount>1</LineAmount>
<RawDims>sample string 13</RawDims>
<ResolvedGpAccount>sample string 14</ResolvedGpAccount>
<Site>sample string 11</Site>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDetail>
</Details>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 8</DownloadRunId>
<DownloadedDateTime>2026-11-21T05:35:42.7073765+00:00</DownloadedDateTime>
<HeldReason>sample string 7</HeldReason>
<LastRetriedDateTime>2026-11-21T05:35:42.7073765+00:00</LastRetriedDateTime>
<RetryCount>9</RetryCount>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDoc>
<BcApHeldDoc>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<CompanyId>sample string 5</CompanyId>
<Details>
<BcApHeldDetail>
<AttemptNumber>8</AttemptNumber>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<BcNatural>sample string 10</BcNatural>
<CompanyId>sample string 5</CompanyId>
<CreatedDateTime>2026-11-21T05:35:42.7073765+00:00</CreatedDateTime>
<Dept>sample string 12</Dept>
<DocTotal>1</DocTotal>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 7</DownloadRunId>
<FailureCategory>sample string 9</FailureCategory>
<LineAmount>1</LineAmount>
<RawDims>sample string 13</RawDims>
<ResolvedGpAccount>sample string 14</ResolvedGpAccount>
<Site>sample string 11</Site>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDetail>
<BcApHeldDetail>
<AttemptNumber>8</AttemptNumber>
<BcInvoiceId>sample string 1</BcInvoiceId>
<BcInvoiceNumber>sample string 2</BcInvoiceNumber>
<BcNatural>sample string 10</BcNatural>
<CompanyId>sample string 5</CompanyId>
<CreatedDateTime>2026-11-21T05:35:42.7073765+00:00</CreatedDateTime>
<Dept>sample string 12</Dept>
<DocTotal>1</DocTotal>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 7</DownloadRunId>
<FailureCategory>sample string 9</FailureCategory>
<LineAmount>1</LineAmount>
<RawDims>sample string 13</RawDims>
<ResolvedGpAccount>sample string 14</ResolvedGpAccount>
<Site>sample string 11</Site>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDetail>
</Details>
<DocType>sample string 4</DocType>
<DownloadRunId>sample string 8</DownloadRunId>
<DownloadedDateTime>2026-11-21T05:35:42.7073765+00:00</DownloadedDateTime>
<HeldReason>sample string 7</HeldReason>
<LastRetriedDateTime>2026-11-21T05:35:42.7073765+00:00</LastRetriedDateTime>
<RetryCount>9</RetryCount>
<VendorDocNumber>sample string 3</VendorDocNumber>
<VendorId>sample string 6</VendorId>
</BcApHeldDoc>
</ArrayOfBcApHeldDoc>