Create Cash Disbursement Control

POST {{base_url}}/DataEntry/cdControl

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 cash disbursements.

Request Body

{"Batch"=>"CDAPIIBatch00001", "Description"=>"Cash Disbursement API Test 1", "Recurring"=>"N", "EndDate"=>"2017-12-31T00:00:00.000", "Total"=>12.21, "SumTotal"=>12.21, "DiffTotal"=>0, "DefaultBank"=>"127", "DefaultBankDescription"=>"Bank North - Canada", "BankCurrencyCode"=>"CAD", "Selected"=>"N", "Posted"=>"N", "Creator"=>"ADMIN", "Period"=>201305, "Company"=>"A0", "cdControlDefaultTaxCodes"=>[{"TaxCode"=>"AGS", "Batch"=>"CDAPIIBatch00001", "Seq"=>1}, {"TaxCode"=>"NY_TAX", "Batch"=>"CDAPIIBatch00001", "Seq"=>2}, {"TaxCode"=>"AMA", "Batch"=>"CDAPIIBatch00001", "Seq"=>3}], "cdMaster"=>[{"Batch"=>"CDAPIIBatch00001", "CheckNo"=>"9988", "BankCode"=>"127", "TransDate"=>"2017-12-01T00:00:00.000", "Payee"=>"Test Payee", "Posted"=>"N", "Seq"=>0, "CurrencyCode"=>"CAD", "CurrencyExchangeOverrideMethod"=>"N", "CurrencyExchangeOverrideDate"=>"", "CurrencyExchangeOverrideRate"=>0, "Status"=>"N", "AuthorizedBy"=>"", "RejectReason"=>"", "ModUser"=>"", "ModDate"=>"", "Diary"=>"", "DiaryNo"=>0}], "cdDetail"=>[{"Batch"=>"CDAPIIBatch00001", "CheckNo"=>"9988", "PKey"=>"PKEY000ABC1", "Seq"=>1, "Description"=>"test1", "WBS1"=>"0A199900.900", "WBS2"=>"A000", "WBS3"=>" ", "Account"=>"41113", "NetAmount"=>100, "Amount"=>130, "CurrencyExchangeOverrideRate"=>0, "LinkCompany"=>""}], "cdDetailTax"=>[{"Batch"=>"CDAPIIBatch00001", "CheckNo"=>"9988", "PKey"=>"PKEY000ABC1", "TaxCode"=>"NY_TAX", "Seq"=>1, "TaxAmount"=>10, "CompoundOnTaxCode"=>""}, {"Batch"=>"CDAPIIBatch00001", "CheckNo"=>"9988", "PKey"=>"PKEY000ABC1", "TaxCode"=>"AGS", "Seq"=>2, "TaxAmount"=>20, "CompoundOnTaxCode"=>""}]}

HEADERS

KeyDatatypeRequiredDescription
Content-TypestringRequired.

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":"CDAPIIBatch00001","Description":"Cash Disbursement API Test 1","Recurring":"N","EndDate":"2017-12-31T00:00:00.000","Total":12.21,"SumTotal":130,"DiffTotal":-117.79,"DefaultBank":"127","DefaultBankDescription":"Bank North - Canada","BankCurrencyCode":"CAD","Selected":"N","Posted":"N","Creator":"ADMIN","Period":201305,"Company":"A0"}]