{ "opencollection": "1.0.0", "info": { "name": "Denim Public API Reference Documentation Companies Jobs V2 API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Jobs V2", "type": "folder" }, "items": [ { "info": { "name": "List Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://staging.denim.com/api/v2/jobs", "params": [ { "name": "query", "value": "$1,000.00", "type": "query", "description": "Search by company name, amount, or job number" }, { "name": "status", "value": "approved", "type": "query", "description": "Job statuses" }, { "name": "needs_attention", "value": "", "type": "query", "description": "When true, return only jobs that need attention: manual/admin flag OR actionable document-audit issue." }, { "name": "page", "value": "1", "type": "query", "description": "The page of results to query." }, { "name": "per_page", "value": "10", "type": "query", "description": "The number of entities per page of results." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "A job is a collection of payables, receivables, and fees (obligations) associated with an invoice or purchase order." }, { "info": { "name": "Create a Job", "type": "http" }, "http": { "method": "POST", "url": "https://staging.denim.com/api/v2/jobs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Create a new Job using our V2 API. Jobs created with this API can have certain Denim relationship IDs ommitted in favor of external IDs. Clients will then be able to utilitze the Denim Dashboard to review these Jobs and complete any mappings as necessary. Once a mapping between an external ID and a Denim ID has been completed, it will not need to be mapped for future Jobs." }, { "info": { "name": "Show a Job by ID", "type": "http" }, "http": { "method": "GET", "url": "https://staging.denim.com/api/v2/jobs/:job_id", "params": [ { "name": "id", "value": "06f9eccc-e5df-44ce-ba68-d4ccbdbc33e6", "type": "path", "description": "Job UUID" } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "Returns a Job by UUID. This can return either a Job or a Job in Import Review. If the Job has been created, it will return a Job. If the Job has not yet been sumitted as a draft job and is under client_review, this will return a slimmer Job schema." }, { "info": { "name": "Create a Job Document", "type": "http" }, "http": { "method": "POST", "url": "https://staging.denim.com/api/v2/jobs/:job_id/document", "params": [ { "name": "id", "value": "06f9eccc-e5df-44ce-ba68-d4ccbdbc33e6", "type": "path", "description": "Job UUID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "This endpoint enables adding documents to existing jobs. This can accept either a json body with a publicly accessible `url`, `type` and `subtype`, or a multi-part form body including a `file` as the binary and `type` and `subtype`. In either case, the document will be uploaded and stored to our secure Google Cloud Platform storage.\n" } ] } ], "bundled": true }