{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"72b88960-2655-4fa1-84e3-995989b3e8f2","name":"Customer","description":"# Customer API\n\nREST API for customer integrations with Listo.\n\n## Authentication\n\nAll requests require authentication using a **static access token**.\n\nInclude the following header in every request:\n\n| Header | Value |\n| --- | --- |\n| Authorization | `Token` |\n\nExample:\n\n``` http\nAuthorization: Token abc123456789...\n\n ```\n\nThe access token is provided by **Listo** and must be included in every API request.\n\n---\n\n## Pagination\n\nEndpoints that return invoice listings support pagination using the `size` and `offset` query parameters.\n\n| Parameter | Description |\n| --- | --- |\n| `size` | Number of records returned per request. Maximum value is **1000**. |\n| `offset` | Starting position (cursor) from which records are returned. |\n\nAlthough the API supports up to **1000 invoices per request**, we recommend using **500 records per request** as the optimal balance between response time and payload size.\n\nPagination is **cursor-based**, where `offset` represents the index of the first record to return, **not the page number**.\n\nExample:\n\n| Page | size | offset |\n| --- | --- | --- |\n| 1 | 500 | 0 |\n| 2 | 500 | 500 |\n| 3 | 500 | 1000 |\n| 4 | 500 | 1500 |\n\nExample request:\n\n``` http\nGET /api/invoices/export_json?size=500&offset=1000\n\n ```\n\n---\n\n## Filtering\n\nListing endpoints support a wide variety of filters (dates, UUID, RFC, invoice type, payment status, amounts, folios, etc.).\n\n**Filters can be combined**, allowing highly specific searches. For example, a request may filter invoices simultaneously by:\n\n- Date range\n    \n- RFC\n    \n- Invoice type (Income or Expense)\n    \n- Payment status\n    \n- Amount\n    \n- Series and Folio\n    \n\nRefer to each endpoint documentation for the list of supported filter parameters.\n\n---\n\n## Companies (RFCs)\n\nEach customer account may contain multiple companies (RFCs).\n\nSeveral endpoints require the `rfc_id` parameter to identify the company on which the operation will be performed.\n\nUse the **Utils → Get customers info** endpoint to retrieve the available companies and their corresponding `rfc_id` values.\n\n---\n\n## General Notes\n\n- All endpoints require authentication.\n    \n- Unless otherwise specified, all responses are returned in JSON format.\n    \n- Download endpoints return the original binary file (PDF, XML or ZIP).\n    \n- Response times may increase when requesting large datasets. For optimal performance, Listo recommends using a page size of **500 records**.\n    \n\n## API Rest for customer usage\n\n1. Listing invoices\n    \n2. Invoicing\n    \n\n|  | Value | Description |\n| --- | --- | --- |\n| `{base_url}` | {{base_url}} |  |\n| `{token}` | Provided by Listo | Access token |\n| `{rfc_id}` | Type integer | Each customer supports multiple companies, RFC_ID is the unique identifier to each company. See [Utils/Get customers info](#f334210e-7073-44b4-9a20-7027c22033a4) for further detail |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12920824","team":1327387,"collectionId":"72b88960-2655-4fa1-84e3-995989b3e8f2","publishedId":"TVYAg1Pq","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12920824/TVYAg1Pq","privateUrl":"https://go.postman.co/documentation/12920824-72b88960-2655-4fa1-84e3-995989b3e8f2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"233F4B"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.3","publishDate":"2020-10-19T19:12:54.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"ApiDocs","id":"5ed1652f-4a40-480c-adf8-253f91969ead","owner":"12920824","values":[{"key":"base_url","value":"https://listo.mx","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/d383aa3fbd5c24d1f3c623c766128f9b7d07698db6091f6831712e74b1095ebd","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":"ApiDocs","value":"12920824-5ed1652f-4a40-480c-adf8-253f91969ead"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVYAg1Pq"}