CodeIQ

Submit a coding job

Runs the real CodeIQ coding pipeline over caller-supplied transactions against a caller-supplied chart of accounts. Async; poll poll_url.

Strict format (HTTP 422 invalid_request_format on any deviation, with section/row/field detail):

  • transactions[]: { date: 'YYYY-MM-DD' (real calendar date), description: 1..500, amount: signed finite number (money out negative), merchant?: <=200, reference?: <=100 }.
  • chart_of_accounts[]: { code: 1..50, name: 1..200, type: one of INCOME, EXPENSE, ASSET, LIABILITY, EQUITY (case-insensitive; REVENUE is accepted as an alias of INCOME) }.
  • vat_codes[] (optional): { code: 1..50, name: 1..200, rate: 0..100 }. If omitted, the default UK universal set (ST/RR/ZR/EX/NV) is used.
  • options (optional): { allowOverage?: boolean (default false), businessContext?: string <=2000 }.

VAT codes returned are universal codes: NV, ST, RR, EX, ZR.

Credits. Cost equals the number of transactions, charged only on a successful completed run. Unaffordable at submit time returns 402 synchronously. Requires scope codeiq:write.

Data minimisation. The transient working session and the submitted transactions are deleted after the result is extracted; only the coded result is retained for polling.

post/api/v1/codeiq/coding-jobs

Request

  • Base URL: https://api.reconcileiq.com
  • URL: https://api.reconcileiq.com/api/v1/codeiq/coding-jobs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

Response

Coding job queued.

coding_job_idstring required
status'queued' required
poll_urlstring required

Example response

{
  "coding_job_id": "cod_4Tn1Ks8Wm2Qx5aZbCd9eF"
}

Changes

No recorded changes to this operation across all 1 revision of this API.