{ "opencollection": "1.0.0", "info": { "name": "Vatstack API Specification Batches Supplies API", "version": "1.3.0" }, "items": [ { "info": { "name": "Supplies", "type": "folder" }, "items": [ { "info": { "name": "Retrieves all supply objects in order of creation, with the most recent appearing highest.", "type": "http" }, "http": { "method": "GET", "url": "https://api.vatstack.com/{basePath}/supplies", "params": [ { "name": "country_code", "value": "", "type": "query", "description": "The 2-letter ISO country code by which you want to filter your records." }, { "name": "issued_since", "value": "", "type": "query", "description": "Show only objects where the `issued` date is this date or later. Format `YYYY-MM-DD`." }, { "name": "issued_until", "value": "", "type": "query", "description": "Show only objects where the `issued` date is this date or earlier. Format `YYYY-MM-DD`." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20." }, { "name": "name", "value": "", "type": "query", "description": "Show only objects with that customer name." }, { "name": "page", "value": "", "type": "query", "description": "Integer for the current page." } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Retrieves all supply objects in order of creation, with the most recent appearing highest." }, { "info": { "name": "Creates a supply object.", "type": "http" }, "http": { "method": "POST", "url": "https://api.vatstack.com/{basePath}/supplies", "body": { "type": "form-urlencoded", "data": [ { "name": "amount", "value": "" }, { "name": "amount_refunded", "value": "" }, { "name": "country_code", "value": "" }, { "name": "currency", "value": "" }, { "name": "description", "value": "" }, { "name": "evidence", "value": "" }, { "name": "invoice_number", "value": "" }, { "name": "issued", "value": "" }, { "name": "name", "value": "" }, { "name": "notes", "value": "" }, { "name": "validation", "value": "" }, { "name": "vat", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Creates a supply object." }, { "info": { "name": "Retrieves a supply object.", "type": "http" }, "http": { "method": "GET", "url": "https://api.vatstack.com/{basePath}/supplies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Retrieves a supply object." }, { "info": { "name": "Updates a supply object by the {id} path parameter.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.vatstack.com/{basePath}/supplies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "amount", "value": "" }, { "name": "amount_refunded", "value": "" }, { "name": "country_code", "value": "" }, { "name": "currency", "value": "" }, { "name": "description", "value": "" }, { "name": "evidence", "value": "" }, { "name": "invoice_number", "value": "" }, { "name": "issued", "value": "" }, { "name": "name", "value": "" }, { "name": "notes", "value": "" }, { "name": "validation", "value": "" }, { "name": "vat", "value": "" } ] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Updates a supply object by the {id} path parameter." }, { "info": { "name": "Deletes a supply object by the {id} path parameter.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.vatstack.com/{basePath}/supplies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Deletes a supply object by the {id} path parameter." } ] } ], "bundled": true }