POST api/toolchest/RetryBcApHeld?commit={commit}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| commit | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
BcApRunResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Mode | string |
None. |
|
| InvoicesPulled | integer |
None. |
|
| InvoicesWritten | integer |
None. |
|
| InvoicesHeld | integer |
None. |
|
| InvoicesSkippedAlreadyWritten | integer |
None. |
|
| CreditMemosPulled | integer |
None. |
|
| CreditMemosWritten | integer |
None. |
|
| CreditMemosHeld | integer |
None. |
|
| CreditMemosSkippedAlreadyWritten | integer |
None. |
|
| InvoicesNotPosted | integer |
None. |
|
| CreditMemosNotPosted | integer |
None. |
|
| RowsWritten | integer |
None. |
|
| Outcomes | Collection of BcApInvoiceOutcome |
None. |
|
| Failures | Collection of BcApFailure |
None. |
|
| Companies | Collection of BcApCompanyTally |
None. |
|
| Processor | BcApProcessorOutcome |
None. |
|
| RunLock | BcApRunLock |
None. |
Response Formats
application/json, text/json
Sample:
{
"Mode": "sample string 1",
"InvoicesPulled": 2,
"InvoicesWritten": 3,
"InvoicesHeld": 4,
"InvoicesSkippedAlreadyWritten": 5,
"CreditMemosPulled": 6,
"CreditMemosWritten": 7,
"CreditMemosHeld": 8,
"CreditMemosSkippedAlreadyWritten": 9,
"InvoicesNotPosted": 10,
"CreditMemosNotPosted": 11,
"RowsWritten": 12,
"Outcomes": [
{
"DocType": "sample string 1",
"CompanyId": "sample string 2",
"Number": "sample string 3",
"BcInvoiceId": "sample string 4",
"VendorDocNumber": "sample string 5",
"Outcome": "sample string 6",
"HeldReason": "sample string 7",
"PayablesAccount": "sample string 8",
"DocTotal": 9.0,
"Lines": [
{
"LineObjectNumber": "sample string 1",
"Description": "sample string 2",
"Site": "sample string 3",
"Dept": "sample string 4",
"Resolved": true,
"GpNatural": "sample string 6",
"GpDept": "sample string 7",
"GpSalesRep": "sample string 8",
"GpDivision": "sample string 9",
"GpCompany": "sample string 10",
"AcctNumber": "sample string 11",
"Amount": 12.0,
"HeldReason": "sample string 13",
"BcSent": "sample string 14",
"CandidateAccounts": "sample string 15",
"FailureCategory": "sample string 16",
"MatchPath": "sample string 17",
"SalesRep": "sample string 18"
},
{
"LineObjectNumber": "sample string 1",
"Description": "sample string 2",
"Site": "sample string 3",
"Dept": "sample string 4",
"Resolved": true,
"GpNatural": "sample string 6",
"GpDept": "sample string 7",
"GpSalesRep": "sample string 8",
"GpDivision": "sample string 9",
"GpCompany": "sample string 10",
"AcctNumber": "sample string 11",
"Amount": 12.0,
"HeldReason": "sample string 13",
"BcSent": "sample string 14",
"CandidateAccounts": "sample string 15",
"FailureCategory": "sample string 16",
"MatchPath": "sample string 17",
"SalesRep": "sample string 18"
}
],
"PlannedRows": [
{
"RowType": "sample string 1",
"TransType": "sample string 2",
"DistType": 3,
"AcctNumber": "sample string 4",
"Amount": 5.0,
"Description": "sample string 6",
"CompanyId": "sample string 7"
},
{
"RowType": "sample string 1",
"TransType": "sample string 2",
"DistType": 3,
"AcctNumber": "sample string 4",
"Amount": 5.0,
"Description": "sample string 6",
"CompanyId": "sample string 7"
}
]
},
{
"DocType": "sample string 1",
"CompanyId": "sample string 2",
"Number": "sample string 3",
"BcInvoiceId": "sample string 4",
"VendorDocNumber": "sample string 5",
"Outcome": "sample string 6",
"HeldReason": "sample string 7",
"PayablesAccount": "sample string 8",
"DocTotal": 9.0,
"Lines": [
{
"LineObjectNumber": "sample string 1",
"Description": "sample string 2",
"Site": "sample string 3",
"Dept": "sample string 4",
"Resolved": true,
"GpNatural": "sample string 6",
"GpDept": "sample string 7",
"GpSalesRep": "sample string 8",
"GpDivision": "sample string 9",
"GpCompany": "sample string 10",
"AcctNumber": "sample string 11",
"Amount": 12.0,
"HeldReason": "sample string 13",
"BcSent": "sample string 14",
"CandidateAccounts": "sample string 15",
"FailureCategory": "sample string 16",
"MatchPath": "sample string 17",
"SalesRep": "sample string 18"
},
{
"LineObjectNumber": "sample string 1",
"Description": "sample string 2",
"Site": "sample string 3",
"Dept": "sample string 4",
"Resolved": true,
"GpNatural": "sample string 6",
"GpDept": "sample string 7",
"GpSalesRep": "sample string 8",
"GpDivision": "sample string 9",
"GpCompany": "sample string 10",
"AcctNumber": "sample string 11",
"Amount": 12.0,
"HeldReason": "sample string 13",
"BcSent": "sample string 14",
"CandidateAccounts": "sample string 15",
"FailureCategory": "sample string 16",
"MatchPath": "sample string 17",
"SalesRep": "sample string 18"
}
],
"PlannedRows": [
{
"RowType": "sample string 1",
"TransType": "sample string 2",
"DistType": 3,
"AcctNumber": "sample string 4",
"Amount": 5.0,
"Description": "sample string 6",
"CompanyId": "sample string 7"
},
{
"RowType": "sample string 1",
"TransType": "sample string 2",
"DistType": 3,
"AcctNumber": "sample string 4",
"Amount": 5.0,
"Description": "sample string 6",
"CompanyId": "sample string 7"
}
]
}
],
"Failures": [
{
"DocType": "sample string 1",
"CompanyId": "sample string 2",
"Number": "sample string 3",
"VendorDocNumber": "sample string 4",
"Reason": "sample string 5"
},
{
"DocType": "sample string 1",
"CompanyId": "sample string 2",
"Number": "sample string 3",
"VendorDocNumber": "sample string 4",
"Reason": "sample string 5"
}
],
"Companies": [
{
"CompanyId": "sample string 1",
"InvoicesPulled": 2,
"InvoicesWritten": 3,
"InvoicesHeld": 4,
"InvoicesSkippedAlreadyWritten": 5,
"CreditMemosPulled": 6,
"CreditMemosWritten": 7,
"CreditMemosHeld": 8,
"CreditMemosSkippedAlreadyWritten": 9,
"InvoicesNotPosted": 10,
"CreditMemosNotPosted": 11,
"RowsWritten": 12,
"HasActivity": true
},
{
"CompanyId": "sample string 1",
"InvoicesPulled": 2,
"InvoicesWritten": 3,
"InvoicesHeld": 4,
"InvoicesSkippedAlreadyWritten": 5,
"CreditMemosPulled": 6,
"CreditMemosWritten": 7,
"CreditMemosHeld": 8,
"CreditMemosSkippedAlreadyWritten": 9,
"InvoicesNotPosted": 10,
"CreditMemosNotPosted": 11,
"RowsWritten": 12,
"HasActivity": true
}
],
"Processor": {
"Outcome": "sample string 1",
"Message": "sample string 2",
"StagedRowsBefore": 3,
"StagedRowsAfter": 4,
"ElapsedMs": 5,
"WasLockConflict": true,
"ProcessedRowsBefore": 7,
"ProcessedRowsAfter": 8,
"ProcessedRowsDelta": 9,
"WriteBackFailed": true,
"GpVouchers": [
{
"CompanyId": "sample string 1",
"RowIdWatermark": 2,
"VoucherCount": 3,
"Batches": [
{
"BatchNumber": "sample string 1",
"VoucherCount": 2
},
{
"BatchNumber": "sample string 1",
"VoucherCount": 2
}
],
"LedgerRowsStamped": 4
},
{
"CompanyId": "sample string 1",
"RowIdWatermark": 2,
"VoucherCount": 3,
"Batches": [
{
"BatchNumber": "sample string 1",
"VoucherCount": 2
},
{
"BatchNumber": "sample string 1",
"VoucherCount": 2
}
],
"LedgerRowsStamped": 4
}
],
"GpVouchersCreated": 11,
"GpVoucherError": "sample string 12",
"GpLedgerRowsStamped": 13,
"GpLedgerStampError": "sample string 14"
},
"RunLock": {
"Outcome": "sample string 1",
"Acquired": true,
"RefusedByConcurrentRun": true,
"Message": "sample string 4"
}
}
application/xml, text/xml
Sample:
<BcApRunResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<Companies>
<BcApCompanyTally>
<CompanyId>sample string 1</CompanyId>
<CreditMemosHeld>8</CreditMemosHeld>
<CreditMemosNotPosted>11</CreditMemosNotPosted>
<CreditMemosPulled>6</CreditMemosPulled>
<CreditMemosSkippedAlreadyWritten>9</CreditMemosSkippedAlreadyWritten>
<CreditMemosWritten>7</CreditMemosWritten>
<InvoicesHeld>4</InvoicesHeld>
<InvoicesNotPosted>10</InvoicesNotPosted>
<InvoicesPulled>2</InvoicesPulled>
<InvoicesSkippedAlreadyWritten>5</InvoicesSkippedAlreadyWritten>
<InvoicesWritten>3</InvoicesWritten>
<RowsWritten>12</RowsWritten>
</BcApCompanyTally>
<BcApCompanyTally>
<CompanyId>sample string 1</CompanyId>
<CreditMemosHeld>8</CreditMemosHeld>
<CreditMemosNotPosted>11</CreditMemosNotPosted>
<CreditMemosPulled>6</CreditMemosPulled>
<CreditMemosSkippedAlreadyWritten>9</CreditMemosSkippedAlreadyWritten>
<CreditMemosWritten>7</CreditMemosWritten>
<InvoicesHeld>4</InvoicesHeld>
<InvoicesNotPosted>10</InvoicesNotPosted>
<InvoicesPulled>2</InvoicesPulled>
<InvoicesSkippedAlreadyWritten>5</InvoicesSkippedAlreadyWritten>
<InvoicesWritten>3</InvoicesWritten>
<RowsWritten>12</RowsWritten>
</BcApCompanyTally>
</Companies>
<CreditMemosHeld>8</CreditMemosHeld>
<CreditMemosNotPosted>11</CreditMemosNotPosted>
<CreditMemosPulled>6</CreditMemosPulled>
<CreditMemosSkippedAlreadyWritten>9</CreditMemosSkippedAlreadyWritten>
<CreditMemosWritten>7</CreditMemosWritten>
<Failures>
<BcApFailure>
<CompanyId>sample string 2</CompanyId>
<DocType>sample string 1</DocType>
<Number>sample string 3</Number>
<Reason>sample string 5</Reason>
<VendorDocNumber>sample string 4</VendorDocNumber>
</BcApFailure>
<BcApFailure>
<CompanyId>sample string 2</CompanyId>
<DocType>sample string 1</DocType>
<Number>sample string 3</Number>
<Reason>sample string 5</Reason>
<VendorDocNumber>sample string 4</VendorDocNumber>
</BcApFailure>
</Failures>
<InvoicesHeld>4</InvoicesHeld>
<InvoicesNotPosted>10</InvoicesNotPosted>
<InvoicesPulled>2</InvoicesPulled>
<InvoicesSkippedAlreadyWritten>5</InvoicesSkippedAlreadyWritten>
<InvoicesWritten>3</InvoicesWritten>
<Mode>sample string 1</Mode>
<Outcomes>
<BcApInvoiceOutcome>
<BcInvoiceId>sample string 4</BcInvoiceId>
<CompanyId>sample string 2</CompanyId>
<DocTotal>9</DocTotal>
<DocType>sample string 1</DocType>
<HeldReason>sample string 7</HeldReason>
<Lines>
<BcApResolvedLine>
<AcctNumber>sample string 11</AcctNumber>
<Amount>12</Amount>
<BcSent>sample string 14</BcSent>
<CandidateAccounts>sample string 15</CandidateAccounts>
<Dept>sample string 4</Dept>
<Description>sample string 2</Description>
<FailureCategory>sample string 16</FailureCategory>
<GpCompany>sample string 10</GpCompany>
<GpDept>sample string 7</GpDept>
<GpDivision>sample string 9</GpDivision>
<GpNatural>sample string 6</GpNatural>
<GpSalesRep>sample string 8</GpSalesRep>
<HeldReason>sample string 13</HeldReason>
<LineObjectNumber>sample string 1</LineObjectNumber>
<MatchPath>sample string 17</MatchPath>
<Resolved>true</Resolved>
<SalesRep>sample string 18</SalesRep>
<Site>sample string 3</Site>
</BcApResolvedLine>
<BcApResolvedLine>
<AcctNumber>sample string 11</AcctNumber>
<Amount>12</Amount>
<BcSent>sample string 14</BcSent>
<CandidateAccounts>sample string 15</CandidateAccounts>
<Dept>sample string 4</Dept>
<Description>sample string 2</Description>
<FailureCategory>sample string 16</FailureCategory>
<GpCompany>sample string 10</GpCompany>
<GpDept>sample string 7</GpDept>
<GpDivision>sample string 9</GpDivision>
<GpNatural>sample string 6</GpNatural>
<GpSalesRep>sample string 8</GpSalesRep>
<HeldReason>sample string 13</HeldReason>
<LineObjectNumber>sample string 1</LineObjectNumber>
<MatchPath>sample string 17</MatchPath>
<Resolved>true</Resolved>
<SalesRep>sample string 18</SalesRep>
<Site>sample string 3</Site>
</BcApResolvedLine>
</Lines>
<Number>sample string 3</Number>
<Outcome>sample string 6</Outcome>
<PayablesAccount>sample string 8</PayablesAccount>
<PlannedRows>
<BcApWriteRow>
<AcctNumber>sample string 4</AcctNumber>
<Amount>5</Amount>
<CompanyId>sample string 7</CompanyId>
<Description>sample string 6</Description>
<DistType>3</DistType>
<RowType>sample string 1</RowType>
<TransType>sample string 2</TransType>
</BcApWriteRow>
<BcApWriteRow>
<AcctNumber>sample string 4</AcctNumber>
<Amount>5</Amount>
<CompanyId>sample string 7</CompanyId>
<Description>sample string 6</Description>
<DistType>3</DistType>
<RowType>sample string 1</RowType>
<TransType>sample string 2</TransType>
</BcApWriteRow>
</PlannedRows>
<VendorDocNumber>sample string 5</VendorDocNumber>
</BcApInvoiceOutcome>
<BcApInvoiceOutcome>
<BcInvoiceId>sample string 4</BcInvoiceId>
<CompanyId>sample string 2</CompanyId>
<DocTotal>9</DocTotal>
<DocType>sample string 1</DocType>
<HeldReason>sample string 7</HeldReason>
<Lines>
<BcApResolvedLine>
<AcctNumber>sample string 11</AcctNumber>
<Amount>12</Amount>
<BcSent>sample string 14</BcSent>
<CandidateAccounts>sample string 15</CandidateAccounts>
<Dept>sample string 4</Dept>
<Description>sample string 2</Description>
<FailureCategory>sample string 16</FailureCategory>
<GpCompany>sample string 10</GpCompany>
<GpDept>sample string 7</GpDept>
<GpDivision>sample string 9</GpDivision>
<GpNatural>sample string 6</GpNatural>
<GpSalesRep>sample string 8</GpSalesRep>
<HeldReason>sample string 13</HeldReason>
<LineObjectNumber>sample string 1</LineObjectNumber>
<MatchPath>sample string 17</MatchPath>
<Resolved>true</Resolved>
<SalesRep>sample string 18</SalesRep>
<Site>sample string 3</Site>
</BcApResolvedLine>
<BcApResolvedLine>
<AcctNumber>sample string 11</AcctNumber>
<Amount>12</Amount>
<BcSent>sample string 14</BcSent>
<CandidateAccounts>sample string 15</CandidateAccounts>
<Dept>sample string 4</Dept>
<Description>sample string 2</Description>
<FailureCategory>sample string 16</FailureCategory>
<GpCompany>sample string 10</GpCompany>
<GpDept>sample string 7</GpDept>
<GpDivision>sample string 9</GpDivision>
<GpNatural>sample string 6</GpNatural>
<GpSalesRep>sample string 8</GpSalesRep>
<HeldReason>sample string 13</HeldReason>
<LineObjectNumber>sample string 1</LineObjectNumber>
<MatchPath>sample string 17</MatchPath>
<Resolved>true</Resolved>
<SalesRep>sample string 18</SalesRep>
<Site>sample string 3</Site>
</BcApResolvedLine>
</Lines>
<Number>sample string 3</Number>
<Outcome>sample string 6</Outcome>
<PayablesAccount>sample string 8</PayablesAccount>
<PlannedRows>
<BcApWriteRow>
<AcctNumber>sample string 4</AcctNumber>
<Amount>5</Amount>
<CompanyId>sample string 7</CompanyId>
<Description>sample string 6</Description>
<DistType>3</DistType>
<RowType>sample string 1</RowType>
<TransType>sample string 2</TransType>
</BcApWriteRow>
<BcApWriteRow>
<AcctNumber>sample string 4</AcctNumber>
<Amount>5</Amount>
<CompanyId>sample string 7</CompanyId>
<Description>sample string 6</Description>
<DistType>3</DistType>
<RowType>sample string 1</RowType>
<TransType>sample string 2</TransType>
</BcApWriteRow>
</PlannedRows>
<VendorDocNumber>sample string 5</VendorDocNumber>
</BcApInvoiceOutcome>
</Outcomes>
<Processor>
<ElapsedMs>5</ElapsedMs>
<GpLedgerRowsStamped>13</GpLedgerRowsStamped>
<GpLedgerStampError>sample string 14</GpLedgerStampError>
<GpVoucherError>sample string 12</GpVoucherError>
<GpVouchers>
<BcApGpCompanyVouchers>
<Batches>
<BcApGpVoucherBatch>
<BatchNumber>sample string 1</BatchNumber>
<VoucherCount>2</VoucherCount>
</BcApGpVoucherBatch>
<BcApGpVoucherBatch>
<BatchNumber>sample string 1</BatchNumber>
<VoucherCount>2</VoucherCount>
</BcApGpVoucherBatch>
</Batches>
<CompanyId>sample string 1</CompanyId>
<LedgerRowsStamped>4</LedgerRowsStamped>
<RowIdWatermark>2</RowIdWatermark>
<VoucherCount>3</VoucherCount>
</BcApGpCompanyVouchers>
<BcApGpCompanyVouchers>
<Batches>
<BcApGpVoucherBatch>
<BatchNumber>sample string 1</BatchNumber>
<VoucherCount>2</VoucherCount>
</BcApGpVoucherBatch>
<BcApGpVoucherBatch>
<BatchNumber>sample string 1</BatchNumber>
<VoucherCount>2</VoucherCount>
</BcApGpVoucherBatch>
</Batches>
<CompanyId>sample string 1</CompanyId>
<LedgerRowsStamped>4</LedgerRowsStamped>
<RowIdWatermark>2</RowIdWatermark>
<VoucherCount>3</VoucherCount>
</BcApGpCompanyVouchers>
</GpVouchers>
<GpVouchersCreated>11</GpVouchersCreated>
<Message>sample string 2</Message>
<Outcome>sample string 1</Outcome>
<ProcessedRowsAfter>8</ProcessedRowsAfter>
<ProcessedRowsBefore>7</ProcessedRowsBefore>
<ProcessedRowsDelta>9</ProcessedRowsDelta>
<StagedRowsAfter>4</StagedRowsAfter>
<StagedRowsBefore>3</StagedRowsBefore>
<WasLockConflict>true</WasLockConflict>
<WriteBackFailed>true</WriteBackFailed>
</Processor>
<RowsWritten>12</RowsWritten>
<RunLock>
<Acquired>true</Acquired>
<Message>sample string 4</Message>
<Outcome>sample string 1</Outcome>
<RefusedByConcurrentRun>true</RefusedByConcurrentRun>
</RunLock>
</BcApRunResult>