Permissions needed: VIEW_INVOICES_CASHING\nReturns list of Invoices
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "filter[sale_id]", "type": "integer", "description": "Sale ID" }, { "kind": "optional", "name": "filter[series]", "type": "string", "description": "Invoice series" }, { "kind": "optional", "name": "filter[number]", "type": "integer", "description": "Invoice number (Required if series is provided)
" }, { "kind": "optional", "name": "filter[updated_from]", "type": "stringReturns only the invoices updated after this datetime (exclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56
.000000Z. Timezone offsets such as +02 are rejected. Updated at and created at are returned in UTC in the response.", "format": "date-time" }, { "kind": "optional", "name": "filter[updated_to]", "type": "stringReturns only the invoices updated at or before this datetime (inclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56
.000000Z. Timezone offsets such as +02 are rejected. Updated at and created at are returned in UTC in the response.", "format": "date-time" }, { "kind": "optional", "name": "sort", "type": "string", "description": "Order by field(s) (created_at,updated_at) Use a minus before for descending order -updated_at
" }, { "kind": "optional", "name": "include", "type": "string", "description": "Additional info to include. You can use multiple, comma separated. Options: sale, sale.vet, sale.customer, sale.customer.legalEntity, sale.customer.country, sale.payments, sale.file, sale.treatments, sale.soldServices, sale.record.visitTypes
" }, { "kind": "optional", "name": "detailed", "type": "boolean", "description": "Set to true to get the full invoice details (this significantly increases the response size and response time)
" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links", "customType": "links", "schema": [] }, { "name": "meta", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta", "customType": "meta", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "xvbAADlj6XvYAG913cHLo", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/invoices \\\n --header 'accept: application/json'" }, { "id": "7phEzOQ0QFqAIVXPxZ1sQ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/invoices\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "81aqIGye6Rodyt9k4gt-I", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/invoices\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "SjDIfwQjl7ey9yZQgdbBv", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/invoices\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "xvbAADlj6XvYAG913cHLo" }, "results": { "languages": [ { "id": "rkOssJcKIKo3OPeUCxosL", "language": "200", "code": "// successful operation\n{\n \"data\": [\n {}\n ],\n \"links\": {},\n \"meta\": {}\n}" } ], "selectedLanguageId": "rkOssJcKIKo3OPeUCxosL" } }, "children": [ { "text": "" } ] }