{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1b8d0b2e-0813-42f8-8ceb-4d4cca20717c","name":"Recovr Public API","description":"This documentation is in a BETA state. We anticipate having blindspots and missing use-cases.\n\nThat being said, what you see is what you should get.\n\nIf you see some important information missing, do not hesitate to contact our technical team, through our team lead: pablo@recovr.eu\n\n# Overview\n\nOur API has been built with REST principles and conventions in mind. A set of HTTP codes are used to make your developer's life as easy as possible.\n\n# Endpoints\n\nThe URL is formed as such:\n\n- `https` only\n    \n- `backend.{host}`\n    - `{host}` is either `staging.recovr.eu` for Staging environment or `recovr.eu` for the Production environment\n        \n- `/api/{v1/v2}/routes`\n    - The given paths. They are mentioned throughout this documentation.\n        \n\nAs a result, you can expect having an URL like this for a staging request: `https://backend.staging.recovr.eu/api/v1/invoices`.\n\n# Headers\n\nThe authentication is a token-based one. Upon your account creation, we'll give you 2: `client_id` and `secret_id`.\n\nTo authenticate your request, you need to pass these in the headers of **every request,** with these key/values pairs:\n\n- `secret_id`: your_secret_id\n    \n- `client_id`: your_client_id\n    \n\nTo these Headers, you must add the client, `tenant`, for which you're performing such request.\n\n- `tenant`: `subdomain-of-your-client`\n    \n\n# Pagination\n\nIndex endpoints have a pagination system. Resources are returned in pages of 20.\n\nBy default, you get the first page. To get the subsequent pages, add the `page={page_number}` argument to paginate. Thanks to the metadata returned alongside every index request, you can figure out if you're supposed to paginate. It looks like this:\n\n``` ruby\n    \"metadata\": {\n        \"total\": 1,\n        \"pagination\": {\n            \"total_objects\": 1,\n            \"page_limit\": 20,\n            \"current_page\": 1,\n            \"last_page\": 1\n        }\n    }\n\n ```\n\n# Error Codes\n\nWhat errors and status codes can a user expect? Here is a list of examples :\n\n| HTTP Code | HTTP Reason | Extra information |\n| --- | --- | --- |\n| **401** | Unauthorized | This user is not authorized |\n| **403** | Forbidden | This user has no access to this endpoint |\n| **429** | Too many requests | The limit of requests per minute has been exceeded |\n| **500** | Internal Server Error | Something unexpected happened |\n| **501** | Maintenance | The server is under maintenance |\n\n# Get a resource with your external ID\n\nOn the endpoint listed below, you are able to get the details of the resource by sending your external ID instead of ours, coupled to the boolean param `with_external_id` set to `true`\n\n- Show debtor\n    \n- Show invoice\n    \n- Show credit note\n    \n\n# Lexicon\n\nA list of terms that should be listed to avoid misunderstandings (debtor/creditor/etc)\n\n- _Company_ : is a company that is the Recovr's client\n    \n- _Tenant_ : is the personnal subdomain for a company using Recovr\n    \n- _Debtor_ : a person or company that owes money\n    \n- _Creditor_ : a person or company to whom money is owing","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5144383","team":134526,"collectionId":"1b8d0b2e-0813-42f8-8ceb-4d4cca20717c","publishedId":"T1Dwda1K","public":true,"publicUrl":"https://api.recovr.be","privateUrl":"https://go.postman.co/documentation/5144383-1b8d0b2e-0813-42f8-8ceb-4d4cca20717c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"25c1a4"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-02-21T12:32:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/6eebfda420cec090c04c88f2df2c5dbe241312b1a0ff3ec5fe719b7031fdcf75","favicon":"https://recovr.be/favicon.ico"},"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"}],"canonicalUrl":"https://api.recovr.be/view/metadata/T1Dwda1K"}