{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7016bc92-c11b-416b-a7be-ac49c00d344a","name":"Espresso API v2","description":"Acesse os dados da sua empresa na plataforma Espresso e crie integrações com ERP ou dashboard personalizados. A API Espresso permite que outros sistemas consumam os dados por meio de métodos REST. Esta documentação descreve os métodos disponíveis para leitura, com exemplos de recursos para filtros, ordenção, e consultas mais flexíveis.\n\nPara ter acesso aos dados da sua empresa por meio da API, é necessário a utilização de um token de acesso. O token é único para cada empresa e pode ser solicitado enviando um email para [suporte@espressoapp.com.br](mailto://suporte@espressoapp.com.br). Mantenha o token em local seguro, pois ele dará acesso a dados de sua empresa na plataforma. Se for necessário, por questões de segurança, solicite um novo token.\n\nA API utiliza o padrão Json API, como documentado em [https://jsonapi.org/](https://jsonapi.org/). Uma das grandes vantagens de utilizar esse padrão está em poder utilizar uma das inumeras implemetações (client side) de diferentes linguagens, listadas em [https://jsonapi.org/implementations/#client-libraries](https://jsonapi.org/implementations/#client-libraries).\n\nClique no botão \"Run in Postman\", no canto superior direito, e começe a utilizar a API agora mesmo. Em caso de dúvidas ou sugestões, nos envie um email através do [suporte@espressoapp.com.br](mailto://suporte@espressoapp.com.br).\n\n* * *\n\n### Recursos\n\n##### **Incluir relacionamento**\n\nEm cada é possível incluir os objetos relacionados ao objeto principal. Segue um exemplo abaixo de como incluir as despesas relacionadas ao relatório na listagem de relatórios. Mais informações em [https://jsonapi.org/format/#fetching-includes](https://jsonapi.org/format/#fetching-includes).\n\n```\n# inclui as despesas relacionadas ao relatório\nhttps://app.espressoapp.com.br/api/v2/company/reports?include=expenses\n\n```\n\n##### **Filtros**\n\nÉ possível filtrar por alguns atributos listados na resposta de cada objeto. A abaixo a documentação irá especificar quais campos poderão ser filtrados em cada um dos métodos. Segue um exemplo abaixo de um filtro aplicado ao relatório.\n\n```\n# filtra os relatórios pelo status\nhttps://app.espressoapp.com.br/api/v2/company/reports?filter[status]=0\n\n```\n\n```\n# filtra os relatórios pela data de aprovação\nhttps://app.espressoapp.com.br/api/v2/company/reports?filter[approved_at][ge]=2018-12-01&filter[approved_at][le]=2018-12-30\n\n```\n\n##### **Paginação**\n\nPor padrão, todas as listas de objetos tem paginação. Cada página terá por padrão 20 objetos, podendo ter no máximo 30. Segue abaixo um exemplo de como utilizar a paginação.\n\n```\n# filtra a lista de relatório na segunda página de tamanho 15\nhttps://app.espressoapp.com.br/api/v2/company/reports?page[number]=2&page[size]=15\n\n```\n\n##### **Ordenação**\n\nPor padrão, todas as listas são ordenadas de forma decrescente pelo campo `created_at`. Segue um exemplo abaixo de ordenação dos relatórios.\n\n```\n# ordena de forma crescente pelo número a lista de relatórios\nhttps://app.espressoapp.com.br/api/v2/company/reports?sort=number\n\n```\n\n```\n# ordena de forma decrescente pelo número a lista de relatórios\nhttps://app.espressoapp.com.br/api/v2/company/reports?sort=-number\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3705662","team":498361,"collectionId":"7016bc92-c11b-416b-a7be-ac49c00d344a","publishedId":"Rzfjn8em","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3705662/Rzfjn8em","privateUrl":"https://go.postman.co/documentation/3705662-7016bc92-c11b-416b-a7be-ac49c00d344a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2018-12-12T16:56:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"56727e8f-611e-13d0-75dd-9c99c91dd4a9","owner":"3705662","values":[{"key":"host","value":"https://app.espressoapp.com.br","enabled":true},{"key":"token","value":"xxx.xxxx.xxx","enabled":true},{"key":"credential","value":"xxxxxx","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f5e215fb3ba3290908147ed520720c8e14bea670f448ceca6793547176c72ee7","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"3705662-56727e8f-611e-13d0-75dd-9c99c91dd4a9"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Rzfjn8em"}