Create AP Disbursement Control
POST {{base_url}}/DataEntry/cvControl
NOTE: This applies if you have the Use Files to Group Transactions option set to Yes in Settings » Accounting » Transactions.
Use this endpoint to create a batch for a set of AP disbursements.
Request Body
{"Batch"=>"CVBatch00001", "Description"=>"AP Disbursement API Test 1", "Recurring"=>"N", "EndDate"=>"2017-12-31T00:00:00.000", "Total"=>700, "PayMethod"=>"B", "DefaultLiab"=>"", "DefaultBank"=>"ABOSTON", "DefaultDate"=>"2017-12-11T00:00:00.000", "Selected"=>"N", "Posted"=>"N", "Creator"=>"Import Module", "Period"=>201305, "Company"=>"A0", "cvControlDefaultTaxCodes"=>[{"TaxCode"=>"AGS", "Batch"=>"CVBatch00001", "Seq"=>1}, {"TaxCode"=>"NY_TAX", "Batch"=>"CVBatch00001", "Seq"=>2}, {"TaxCode"=>"AMA", "Batch"=>"CVBatch00001", "Seq"=>3}], "cvMaster"=>[{"Batch"=>"CVBatch00001", "CheckNo"=>"455555", "TransDate"=>"2017-12-10T00:00:00.000", "Vendor"=>"000AAVEN,DD", "InvoiceDate"=>"2013-11-11T00:00:00.000", "Invoice"=>"B13333", "BankCode"=>"ABOSTON", "Address"=>"<Default>", "Posted"=>"N", "PayDate"=>"", "Voucher"=>"000XPayee55", "Seq"=>1, "VendorTaxCode"=>"", "RegAccount"=>"52900", "OHAccount"=>"74300", "DefaultExpenseCode"=>"", "PaymentCurrencyCode"=>"USD", "CurrencyCode"=>"USD", "CurrencyExchangeOverrideMethod"=>"N", "CurrencyExchangeOverrideDate"=>"", "CurrencyExchangeOverrideRate"=>0, "TransactionID"=>"", "CreditCardCode"=>"", "CreditCardPrimaryCode"=>"", "CreditCardKey"=>"", "Status"=>"N", "AuthorizedBy"=>"", "RejectReason"=>"", "ModUser"=>"", "ModDate"=>"", "Diary"=>"D1", "DiaryNo"=>0}], "cvDetail"=>[{"Batch"=>"CVBatch00001", "CheckNo"=>"455555", "PKey"=>"API0000A1", "Seq"=>1, "Description"=>"Test line 1", "WBS1"=>"0A199900.900", "WBS2"=>"A000", "WBS3"=>" ", "Account"=>"61100", "NetAmount"=>300, "Amount"=>375, "PaymentAmount"=>375, "SuppressBill"=>"N", "CurrencyExchangeOverrideRate"=>0, "ExpenseCode"=>"", "OriginatingVendor"=>""}, {"Batch"=>"CVBatch00001", "CheckNo"=>"455555", "PKey"=>"API0000A2", "Seq"=>2, "Description"=>"Test line 2", "WBS1"=>"0A199900.900", "WBS2"=>"A000", "WBS3"=>" ", "Account"=>"61100", "NetAmount"=>200, "Amount"=>200, "PaymentAmount"=>200, "SuppressBill"=>"N", "CurrencyExchangeOverrideRate"=>0, "ExpenseCode"=>"", "OriginatingVendor"=>""}], "cvDetailTax"=>[{"Batch"=>"CVBatch00001", "CheckNo"=>"455555", "PKey"=>"API0000A1", "TaxCode"=>"NY_TAX", "Seq"=>1, "TaxAmount"=>25, "CompoundOnTaxCode"=>""}, {"Batch"=>"CVBatch00001", "CheckNo"=>"455555", "PKey"=>"API0000A1", "TaxCode"=>"AGS", "Seq"=>2, "TaxAmount"=>50, "CompoundOnTaxCode"=>""}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
[{"Batch":"CVBatch00001","Description":"AP Disbursement API Test 1","Recurring":"N","EndDate":"2017-12-31T00:00:00.000","DefaultCurrencyCode":"USD","Total":700,"SumTotal":575,"DiffTotal":125,"PayMethod":"B","DefaultLiab":"","DefaultLiabDescription":"","DefaultBank":"ABOSTON","DefaultBankDescription":"Baybank - Boston","DefaultDate":"2017-12-11T00:00:00.000","Selected":"N","Posted":"N","Creator":"Import Module","Period":201305,"Company":"A0"}]