This documentation describes all the methods available for programmatically interacting with your Upya database and accessing your Upya platform.
\nIt is separated in 3 sections:
\nUpya Manage: covering the REST APIs for handling your cients, contracts, field operators, web users and a other Upya collections.
\nWebhooks: covering how to subscribe to events happening to your different Upya collections
\nUpya Payment Gateway: covering the REST APIs for interacting with Mobile Money Operators and to post payments.
\nUpya Code Gateway: covering the REST APIs for interacting with physical devices managed by Upya.
\nThe Upya API is an HTTP REST API. The API uses resource-oriented URLs, returns JSON from all requests, and uses standard HTTP response codes.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9200381","collectionId":"cae5807b-5f15-4e3e-9fc3-cf09ab01c214","publishedId":"VUr1HCpY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"54e5ce"},"publishDate":"2023-09-01T23:08:34.000Z"},"item":[{"name":"Upya Manage","item":[{"name":"Clients","item":[{"name":"Create clients","id":"45c119ab-01c4-4ed6-8607-91297b379edc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/clients","description":"Endpoint to create a list of new clients by API calls.
\n\n\n\"ClientNumber\" is an optional field in the body but is a mandatory and unique field in the sytem. If you don't specify one, a clientNumber will be automatically generated and assigned to the new client(s). You can select the rule to generate clientNumbers in your Settings (incremental rule, random with a chosen prefix, etc).
\n
See the client schema (in Schema section) to see the full list of contact numbers, dates and geographic/administrative fields that you can specify.
\n","urlObject":{"protocol":"https","path":["data","clients"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"2c893d20-82cc-49c7-9a4f-1302acd4859d","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\n \"clientNumber\": \"C4759813\",\n \"profile\": {\n \"firstName\": \"John\",\n \"lastName\": \"Lennon\",\n \"gender\": \"Male\",\n \"gps\": {\n \"longitude\": \"33.8325807\",\n \"latitude\": \"-13.1451227\"\n },\n \"village\": \"Koko\",\n \"county\": \"Sc chilooko\",\n \"district\": \"Ntchisi\",\n \"region\": \"Central region\",\n \"country\": \"Malawi\"\n },\n \"contact\": {\n \"countryCode\":\"+265\",\n \"mobile\": \"123456768\",\n \"email\": \"john.lennon@gmail.com\"\n }\n}]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 03 Sep 2023 21:57:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"400"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"190-Ao6TdW7dheShEasfnRSv92YWrFs\""}],"cookie":[],"responseTime":null,"body":"{\n \"successes\": [\n {\n \"profile\": {\n \"firstName\": \"John\",\n \"lastName\": \"Lennon\",\n \"gender\": \"Male\",\n \"gps\": {\n \"longitude\": \"33.8325807\",\n \"latitude\": \"-13.1451227\"\n },\n \"village\": \"Koko\",\n \"county\": \"Sc chilooko\",\n \"district\": \"Ntchisi\",\n \"region\": \"Central region\",\n \"country\": \"Malawi\"\n },\n \"clientNumber\": \"C4759813\",\n \"contact\": {\n \"countryCode\": \"+265\",\n \"mobile\": \"123456768\",\n \"fullNumber\": \"265123456768\",\n \"email\": \"john.lennon@gmail.com\"\n }\n }\n ],\n \"errors\": []\n}"},{"id":"ef0e321c-4519-4fb9-b2e6-b09c07110266","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\n \"clientNumber\": \"C4759813\",\n \"profile\":{\n \"lastName\":\"Lennon\"\n }\n}, {\n\"profile\": {\n \"village\": \"Koko\",\n \"county\": \"Sc chilooko\",\n \"district\": \"Ntchisi\",\n \"region\": \"Central region\",\n \"country\": \"Malawi\"\n }\n}]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 03 Sep 2023 22:15:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"116"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"74-WbQIUprxsReBbDxJzxFaXCNKisw\""}],"cookie":[],"responseTime":null,"body":"{\n \"successes\": [],\n \"errors\": [\n {\n \"message\": \"Client C4759813 already in db\"\n },\n {\n \"message\": \"profile.lastName is compulsory\"\n }\n ]\n}"}],"_postman_id":"45c119ab-01c4-4ed6-8607-91297b379edc"},{"name":"Search clients","id":"b70193c6-03ac-4b9b-a36a-5ba85e9e2305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/search/clients","description":"Endpoint to search your clients collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\n\n\nExample: to retrieve all clients updated after the 2018 World Cup final, send the following body:
\n
{\n \"query\": {\n \"updatedAt\": { \n \"$gte\": \"5 July 2018\"\n }\n }\n}\n\nYou can also use the following MongoDb options: sort, limit and select to optimize your request. See MongoDb documentation for more details.
\n\n\nExample: to get the clientNumbers of the 3 most recently clients send the following request:
\n
{\n \"query\": {},\n \"limit\": 3,\n \"select\": \"clientNumber\",\n \"sort\": \"updatedAt\"\n}\n\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any sort value for answer stability reasons.
\n{\n \"query\": {\n \"profile.lastName\": {\"$regex\":\"idane\"}\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\nEndpoint to count the clients matching a given query. Pass through MongoDb-like queries in the body of the request.
\nSee the \"Search clients\" section for more details.
\n{\n \"query\": {\n \"updatedAt\": { \n \"$gte\": \"5 July 2018\",\n \"$lte\": \"6 July 2018\"\n }\n }\n}\n\nEndpoint to retrieve information regarding one client, specified by its clientNumber as a path variable.
\n","urlObject":{"protocol":"https","path":["data","clients",":clientNumber"],"host":["data","upya","io"],"query":[],"variable":[{"description":{"content":"Unique identifier of client being fetched
\n","type":"text/plain"},"type":"any","value":"","key":"clientNumber"}]}},"response":[{"id":"748fd867-d821-4e9f-a463-01a68aa8e1fc","name":"success","originalRequest":{"method":"GET","header":[],"url":"https://data.upya.io/data/clients/C4759813"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 03 Sep 2023 22:55:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"474"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"1da-XxkDNGzhC8bN1lGIMKfir3guw0Q\""}],"cookie":[],"responseTime":null,"body":"{\n \"client\": {\n \"profile\": {\n \"gps\": {\n \"longitude\": \"33.8325807\",\n \"latitude\": \"-13.1451227\"\n },\n \"firstName\": \"John\",\n \"lastName\": \"Lennon\",\n \"gender\": \"Male\",\n \"village\": \"Koko\",\n \"county\": \"Sc chilooko\",\n \"district\": \"Ntchisi\",\n \"region\": \"Central region\",\n \"country\": \"Malawi\"\n },\n \"contact\": {\n \"countryCode\": \"+265\",\n \"mobile\": \"123456768\",\n \"fullNumber\": \"265123456768\",\n \"email\": \"john.lennon@gmail.com\"\n },\n \"_id\": \"64f5016082bcc10019a6d013\",\n \"clientNumber\": \"C4759813\",\n \"entryDate\": \"2023-09-03T21:57:52.500Z\",\n \"status\": \"Pending\"\n }\n}"}],"_postman_id":"238ce951-4eb9-43f5-9885-5639028c4205"},{"name":"Edit client","id":"4fc78f35-9ef4-4044-8a62-3864d02a53f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/clients/:clientNumber","description":"Endpoint to edit an existing client specified by its clientNumber as a path variable.
All changes are tracked by a clientEvent and can be listened to using a webhook
Endpoints relating to your clients collection. Your clients are organized according to their
\nEach one of your clients can have multiple contracts (see contracts section) and multiple forms (see forms section).
\n\n\nCategories allow you to filter what pricing terms, forms (etc) will be available to any particular client.
\n
\n\n","_postman_id":"e1ac6faa-1980-4c8a-8c9e-2876a170c5aa"},{"name":"Contracts","item":[{"name":"Create contract","id":"fa1c2d31-7a29-4861-a10e-a21bf4ff60b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/contracts/create","description":"Progress stages allow you to trigger actions based on changes in the stage at which a client is.
\n
Endpoint to add one new contract to an existing client specified by its clientNumber
\n","urlObject":{"protocol":"https","path":["data","contracts","create"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"49df0ed8-6b38-487a-a34e-c17be56fe844","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientNumber\": \"CL2030617\",\n \"dealName\": \"New\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 16:09:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"454"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"1c6-v3Xw0XVRIrFYOypO3HTjF2U5fR4\""}],"cookie":[],"responseTime":null,"body":"{\n \"clientNumber\": \"CL2030617\",\n \"contractNumber\": \"A84375415\",\n \"dealName\": \"New\",\n \"pricingSchedule\": {\n \"highSeason\": {\n \"months\": []\n },\n \"midSeason\": {\n \"months\": []\n },\n \"lowSeason\": {\n \"months\": []\n },\n \"upfrontPayment\": 570,\n \"minPayment\": 500,\n \"upfrontDays\": 30,\n \"recurrentPayment\": 500,\n \"freq\": 30,\n \"discounts\": []\n },\n \"totalCost\": 1025,\n \"totalPaid\": 0,\n \"entryDate\": \"2023-09-04T16:09:14.144Z\",\n \"status\": \"LOCKED\",\n \"type\": \"PAYG\",\n \"onboardingStatus\": \"Approved\",\n \"lastStatusUpdate\": \"2023-09-04T16:09:14.152Z\"\n}"},{"id":"bf3fd68d-bcf4-46ec-ac3c-3be7b8b59f3e","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientNumber\": \"CL2030617\",\n \"dealNumber\": \"1622549617598\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 04 Sep 2023 15:56:22 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"33"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"21-jevG7pwlow+3K2Q7uKS1ehQ+WiU\""}],"cookie":[],"responseTime":null,"body":"Error - no dealName was specified"}],"_postman_id":"fa1c2d31-7a29-4861-a10e-a21bf4ff60b4"},{"name":"Search contracts","id":"3236d433-7e85-42d6-b70d-9c5e525468de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/search/contracts","description":"Endpoint to search your contracts collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\n\n\nExample: to retrieve all contracts updated after the 1998 World Cup final, send the following body:
\n
{\n \"query\": {\n \"updatedAt\": { \n \"$gte\": \"12 July 2018\"\n }\n }\n}\n\nYou can also use the following MongoDb options: sort, limit and select to optimize your request. See MongoDb documentation for more details.
\n\n\nExample: to get the contractNumbers of the 3 most recently clients send the following request:
\n
{\n \"query\": {},\n \"limit\": 3,\n \"select\": \"contractNumber\",\n \"sort\": \"updatedAt\"\n}\n\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any sort value for answer stability reasons.
\n{\n \"query\": {\n \"totalpaid\": {\"$gte\":1000}\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\nEndpoint to count the contracts matching a given query. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","count","contracts"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"eaa58d8c-6744-4d7f-961a-b146783e90bc","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEndpoint to retrieve information regarding one contract, specified by its contractNumber
\n","urlObject":{"protocol":"https","path":["data","contracts",":contractNumber"],"host":["data","upya","io"],"query":[],"variable":[{"type":"any","value":"","key":"contractNumber"}]}},"response":[],"_postman_id":"fff01e4a-40e5-4ef4-9eab-99778b7456b7"},{"name":"Update contract","id":"47eb3880-5aba-4700-97aa-15670068b3dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/updateOne","description":"Endpoint to \"manually\" update a contract. Equivalent to the \"hard reset\" button on the Upya Manage platform.
\nUpdates made via this endpoint override the specified contract object without being linked to any payment.
\nAll updates are tracked with the creations of \"contract events\".
\n","urlObject":{"protocol":"https","path":["data","contracts","updateOne"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"efc23249-9929-4e87-8c71-f9953eb2409e","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"AC2029652\",\n \"totalPaid\": \"3000\",\n \"flag\": \"Interested\",\n \"categoriesToAdd\": \"Under warranty\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/updateOne"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 16:26:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"34-cD04MsXX8amxvpxGp81Kqh0Ej4o\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Successfully edited\"\n}"}],"_postman_id":"47eb3880-5aba-4700-97aa-15670068b3dc"},{"name":"Change deal","id":"16c0d2e3-c63b-418a-8c96-94309b11dc6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/changedeal","description":"Endpoint to change the deal (pricing terms) of an existing contract. The request will update the pricingSchedule, totalCost and remainingDebt of the contract.
\nEquivalent to the Change deal button of the Upya Manage platform.
\n\n\n","urlObject":{"protocol":"https","path":["data","contracts","changedeal"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"d02232a3-ed83-4146-8cc5-fea954134e91","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"AC2029652\",\n \"dealNumber\": \"X5WX0\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/changedeal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 16:42:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"35-RyUR1SWwvWVrpiU58mURlMPahGY\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Successfully changed\"\n}"},{"id":"4fbbc894-a596-4f6f-b805-468cbfc4589b","name":"error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"AC2029652\",\n \"dealNumber\": \"FTQ8BNXJ\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/changedeal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 16:40:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"33-ipRXXumUWdbNTJixljIbmnFQ5Q4\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"message\": \"No active deal found\"\n}"}],"_postman_id":"16c0d2e3-c63b-418a-8c96-94309b11dc6a"},{"name":"Edit terms","id":"75d5c31d-c894-4b31-a540-a6bd90b037d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/editterms","description":"Warning: the new deal and the old one need to share the same underlying product
\n
Endpoint to edit any of the terms of an existing contract (totalCost, monthly payment, frequency of payments, min payment), without affecting the others.
\nUse this action to modify the economic terms of a given contrat without actually changing the deal of the contract.
\nEquivalent to the Edit terms button of the Upya Manage platform.
\n","urlObject":{"protocol":"https","path":["data","contracts","editterms"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"14bb1d40-e8b5-4add-8a30-4b9f4816c795","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"AC2029652\",\n \"edits\": {\n \"totalCost\": 120000,\n \"pricingSchedule\": {\n \"freq\": 15,\n \"recurrentPayment\": 1000\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/editterms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 20:28:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"34-cD04MsXX8amxvpxGp81Kqh0Ej4o\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Successfully edited\"\n}"},{"id":"128dc8c4-6adb-401c-b6df-f89d6907bb4e","name":"error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"edits\": {\n \"totalCost\": 120000,\n \"pricingSchedule\": {\n \"freq\": 15,\n \"recurrentPayment\": 1000\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/editterms"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 04 Sep 2023 20:29:15 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"41"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"29-eNkYlzIG4S+F3Cm5IBnP1Xw28/I\""}],"cookie":[],"responseTime":null,"body":"No or incorrect contractNumber specified."}],"_postman_id":"75d5c31d-c894-4b31-a540-a6bd90b037d3"},{"name":"Approve contracts","id":"07bacc5b-e2ab-413a-a949-63d70f868b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/approve","description":"Endpoint to approve a list of contracts, specified by their contractNumbers
\nEquivalant to the Approve button on the Upya Manage platform.
\n","urlObject":{"protocol":"https","path":["data","contracts","approve"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"7eaa12a2-893d-434b-8b30-51cbe76e15ab","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumbers\": [\"A98034333\", \"A123564\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/approve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 20:32:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"31-ofUMYi+BR9RH5wfg+Z/gDS/jIvg\""}],"cookie":[],"responseTime":null,"body":"{\n \"successes\": [\n \"A98034333\",\n \"A123564\"\n ],\n \"errors\": []\n}"}],"_postman_id":"07bacc5b-e2ab-413a-a949-63d70f868b56"},{"name":"Reject contracts","id":"18d4ae8b-cd93-493e-806a-7c76b6567a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/reject","description":"Endpoint to reject a contract, specified by its contractNumber
\nEquivalant to the Reject button on the Upya Manage platform.
\n\n\n","urlObject":{"protocol":"https","path":["data","contracts","reject"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"34302b15-7ccf-4042-a561-c9ba48eba905","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"A98034333\",\n \"noteToAgent\": \"Contract failed credit check\",\n \"rejectClient\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/reject"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 22:20:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"98-OBNvhC63zo8PReFxh5h36gA4nao\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": {\n \"rejectedContract\": \"A98034333\",\n \"clientRejected\": true,\n \"noteSentToAgent\": \"Application for test 5 was rejected. Contract failed credit check\"\n }\n}"}],"_postman_id":"18d4ae8b-cd93-493e-806a-7c76b6567a38"},{"name":"Pay off contracts","id":"ecfe9053-197a-4763-aee4-01fcaa50536a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/unlock","description":"You can add a note that will be sent as a pop up notification to the field agent in charge of the client by using the field \"noteToAgent\"
\n
Endpoint to pay-off a list of contracts. The following changes will be applied to each contract in the list:
\ncontract status moved to \"PAIDOFF\"
\npaidOffDate set to today
\nnextStatusUpdate removed
\nremainingDebt set to 0
\nAn unlock code is sent to each client if the \"sendCodeToClients\" flag is set to true
\n","urlObject":{"protocol":"https","path":["data","contracts","unlock"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"b574c54d-fd5b-4e32-9df8-fe47fbcfa257","name":"success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"contractNumbers\": [\"A74189497\"],\n \"sendCodeToClients\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/contracts/unlock"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 22:25:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"3a-FzCLvHBbCdDkboG816n25Fb4QfU\""}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"successes\": [\n {\n \"contractNumber\": \"A74189497\"\n }\n ]\n}"}],"_postman_id":"ecfe9053-197a-4763-aee4-01fcaa50536a"},{"name":"Write off contracts","id":"97b53061-30bf-41bc-a65c-ec4b8fcfaccd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/contracts/writeoff","description":"Endpoint to write-off a list of contracts.
\nThe following rules will apply to each contract in the list:
\nif its status is \"ENABLED\" or \"LOCKED\", both the contract and the attached unit(s) are written-off
\nif its status is \"REPOSSESSED\", only the contract is written-off
\nf its status is \"PAIDOFF\", the action fails
\nif its status is \"WRITEOFF\", the contract is un-writtenoff and the unit is restored (unless the contract was repossessed).
\nUse this endpoint to send bonus days for a given contract.
\nThis action will generate an activation code and will update the \"nextStatusUpdate\" field of the contract. It will however not change the economics of the contract (totalPaid, totalCost, ...).
\nAn event will be logged in the contract history
\n","urlObject":{"protocol":"https","path":["data","codes","send-bonus"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"3a7dd22e-54f9-43ed-afc3-3c4758fd15e1","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEndpoint to \"sync\" a unit attached to a contract. The \"sync\" action aligns the \"lock date\" of the physical unit to the \"nextStatusUpdate\" of the contract.
\nThe \"sync\" action is not available with all manufacurers / hardware.
\n","urlObject":{"protocol":"https","path":["data","codes","syncUnit"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc2e5385-5753-4115-935d-38eb4fbea175"}],"id":"29bd9e83-95a0-470f-b4f6-fa1b2389f654","description":"Use these endpoints to interact with your contracts collection.
\nContracts are organized according to their:
\nonboardingStatus: \"Pending\", \"Approved\", \"Rejected\" or \"Signed
\nstatus: \"LOCKED\", \"ENABLED\", \"REPOSSESSED\", \"PAIDOFF\" or \"WRITEOFF\"
\ncategories: a customizable list that you can define in your settings.
\nflag: a customizable list that you can define in your settings
\n\n\nCategories allow you to filter what units is available to each contract..
\n
\n\nFlags allow you to trigger actions based on changes in the stage at which a contract is.
\n
Your contracts can be linked to one or several serialized units or to one or several non-serialized items. But only to one serialized lockable unit.
\nEach contract is associated to a deal. A deal summarizes the pricing structure of the contract, along with its onboarding process (approval needed or not, questions asked during onboarding, etc...).
\nContracts can be of the following types (attribute inherited from their deal):
\nFULL: full upfront pricing structure (cash sale)
\nPAYG: lease-to-own pricing structure with pre-set monthly instalment (lockable units)
\nINSTALMENT: lease-to-own pricing structure with pre-set monthly instalment (non-lockable units)
\nLOAN: loan pricing structure with weekly or monthly interest rate, early & late repayment rules, etc
\nTOPUP: prepaid pricing structure
\nPERPEUITY: lease pricing structure, with pre-set monthly instalment
\nEndpoint to search your asset collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\nYou can also use the following MongoDb options: sort, limit and select to optimize your request. See MongoDb documentation for more details.
\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any sort value for answer stability reasons.
\n{\n \"query\": {\n \"status\": \"INSTOCK\"\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\nEndpoint to create a list of serialized units. Each element in the list should have the following attributes:
\nThis endpoint is equivalent to the drag and drop zone to create units on the Upya Manage platform.
\n","urlObject":{"protocol":"https","path":["data","assets"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfd7cfe3-d26a-48e2-9318-e7b13878a3f1"},{"name":"Edit units","id":"e1e91c72-90d5-43a3-acde-60ad84ee26c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/assets","description":"Endpoint to edit a list of serialized units:
\n{\n \"data\": [\n {\n \"serialNumber\": \"xxx\",\n \"NewBatchNumber\": \"YYY\"\n }\n ]\n}\n\nEndpoint to write off (or un-write off) a list of units, specified by their serialNumbers.
\nAll elements of the list should have the below structure:
\n","urlObject":{"protocol":"https","path":["data","assets","writeoff"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fb0d872-8e0f-4e51-bf35-45da8b00c45a"},{"name":"Get unit details","id":"4ff017b6-01a6-4507-aa9c-2b122203b0ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data.upya.io/data/assets/:serialNumber","description":"Endpoint to get the details of one serialized units, specified by its serialNumber as a path variable
\n","urlObject":{"protocol":"https","path":["data","assets",":serialNumber"],"host":["data","upya","io"],"query":[],"variable":[{"type":"any","value":"","key":"serialNumber"}]}},"response":[],"_postman_id":"4ff017b6-01a6-4507-aa9c-2b122203b0ef"},{"name":"Transfer units","id":"67596d46-33a6-4c54-8c2d-1db19fe10f75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/assets/transfer","description":"Endpoint to transfer a list of units from one field operator to another one.
\nThe elements of the list should have the following attributes:
\nEquivalent to the Transfer button and to the drag and drop zone to mass transfer units on the Upya Manage platform.
\n\n\n","urlObject":{"protocol":"https","path":["data","assets","transfer"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"67596d46-33a6-4c54-8c2d-1db19fe10f75"},{"name":"Count units","id":"70f1f607-d187-4738-8ffb-515dc63e3683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/count/assets","description":"Warning: non-deployed units cannot by \"held\" by anyone and transfer to non-existing field operator will fail.
\n
Endpoint to count the units matching a given query. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","count","assets"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"23d1f9c0-3d12-4ea2-89a4-a5c1a6eb637a","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query\": {\n \"serialNumber\": {\"$regex\": \"125\"}\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/count/assets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 22:34:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"4b-mrrJkmBeWVUEuG9yy972IaPbLNI\""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 248,\n \"status\": \"Success\",\n \"message\": \"248 units found to match query\"\n}"}],"_postman_id":"70f1f607-d187-4738-8ffb-515dc63e3683"}],"id":"0616bd29-6b33-4ee2-9e9b-7003cbcc14b9","description":"Endpoints related to your assets collection. Your assets are organized according to their status.
\nAvailable status are:
\nDEPLOYED: unit has been sold
\nINSTOCK: unit is in stock and physically with an agent (or warehouse)
\nPENDING: unit is on its way from the manufacturer. Unit cannot be scanned or sold yet
\nDEFECTIVE: unit is defective and cannot as it stands be sold again
\nEndpoint to search your payments collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\nYou can also use the following MongoDb options: sort, limit and select to optimize your request. See MongoDb documentation for more details.
\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any sort value for answer stability reasons.
\n{\n \"query\": {\n \"date\": {\"$gte\":\"01 November 2022\"}\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\nEndpoint to add a list of payments. This is the API equivalent of the Excel loader, that allows to upload bank/MNO statements from Upya Manage.
\nThe query updates the contracts accordingly (totalPaid, debt, status, nextStatusUpdate, etc) and generate all relevant contract events.
\nExisting payments are disregarded (identified by their transactionId).
Unrecognized payments go to un-assigned.
\n","urlObject":{"protocol":"https","path":["data","payments","add"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"529c5a12-5772-4fb4-9055-c9feff3fd90c","name":"success","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEndpoint to count the payments matching a given query. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","count","payments"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"bea6e6dc-3038-4a0f-a05f-f83574ec7bd3","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query\": {\n \"date\": {\n \"$gte\": \"05 August 2023\"\n }\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/count/payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 22:13:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"50-MxEYMOAs5rmvdlJmLe2264LeZ80\""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1791,\n \"status\": \"Success\",\n \"message\": \"1791 payments found to match query\"\n}"}],"_postman_id":"03d861a7-43be-44c6-b8d5-dc772aabdf39"}],"id":"03527056-acbb-4e5f-8bc0-a92b9f1a6fbd","description":"Endpoints relating to your payments collection. Your payments are organized according to their status.
\nAvailable statuses are:
\nACCEPTED: payments that have been successfully processed and allocated to their target contract
\nUNASSIGNED: payments that have been successfully processed but that could not be allocated to any contract
\nFAILED: payments that have been rejected and that have not hit your Mobile Money account
\nPREACCEPTED: payments that have been accepted but for which the relevant contract has not been synced yet by the sale agent
\nEndpoint to search your form collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\n\n\nExample: to retrieve all forms completed for the \"Example\" questionnaire, send the following body:
\n
{\n \"query\": {\n \"name\": \"Example\"\n }\n}\n\nYou can also use the following MongoDb options: sort and limit to optimize your request. See MongoDb documentation for more details.
\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any \"sort\" input for answer stability reasons.
\n{\n \"query\": {\n \"name\": {\"$regex\":\"Example\"}\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\nEndpoint to count the forms matching a given query. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","count","forms"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"ecc926ac-c76c-440f-b823-224bb2b684b7","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet signedUrls to download images from Firestore.
\n","urlObject":{"protocol":"https","path":["data","forms","signedUrls"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e1f0f23-df6d-4d52-964a-b317d8e0348a"}],"id":"0848ed42-945e-44bd-943b-3071d02f80ea","description":"Forms are created each time data is collected on the ground. Forms can be \"client-linked\" or \"standalone\" (meaning not linked to any client).
\nClient-linked forms can be \"onboarding\" forms or forms completed by existing clients.
\nYou can attach forms to clients, to contracts, tasks and tickets.
\n","_postman_id":"0848ed42-945e-44bd-943b-3071d02f80ea"},{"name":"Mobile App Users","item":[{"name":"Create app users","id":"2db7d68d-de17-4fc5-a60f-d07a1862a8cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/agents","description":"Endpoint to create a list of agents. Elements of the list should use the following attributes
\n","urlObject":{"protocol":"https","path":["data","agents"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"86803d7c-f453-44b4-864d-610224e985b6","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEndpoint to search the agent collection. Pass through MongoDb-like queries in the body of your request.
\n","urlObject":{"protocol":"https","path":["data","search","agents"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"99d9161b-0579-4d30-90d9-14ae129a8018","name":"success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BasicEndpoint to edit an existing agent specified by its agentNumber
\n","urlObject":{"protocol":"https","path":["data","agents"],"host":["data","upya","io"],"query":[],"variable":[{"id":"a02ef567-c701-4873-b114-e07f759b5983","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"Endpoints relating to your mobile app users. Default available roles for mobile app users are
\nAgent: standard field operators
\nWarehouse: app users with special rights in terms of scanning units in and out of stock
\n\n\nYou can set up your own list of mobile app user roles in your settings. For example: Manager, Technician, etc
\n
You can set up accessibility rules for each product, form, pricing terms (deal), ticket template or challenge, based on app users' roles.
\n\n\nExample: make the \"Technnical Incident\" form only accessible to mobile app users with the \"Technician\" role.
\n
You can create teams, create managers and set n+1 and n+2 to all app users.
\nImportant: credentials for the mobile app do not work for the web platform, and vice and versa. You can however attach a mobile app profile (and credentials) to any web platform user.
\n","_postman_id":"68145a0f-ebe7-4494-8df8-8f9003b5468a"},{"name":"Products","item":[{"name":"Create product","id":"38f2b7a2-5cbf-497b-9968-24549d5c2a91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/products/create","description":"Use this endpoint to set up a new product.
\n","urlObject":{"protocol":"https","path":["data","products","create"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"236214ba-6dfb-49aa-985b-c6c91a064190","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"productReference\": \"BI620\",\n \"name\": \"620\",\n \"category\": \"Energy\",\n \"manufacturer\": \"Biolite\",\n \"lockable\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/products/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 22:56:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"56-arELkCG/CESeCNRMzBNV5k1MEis\""}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"message\": \"Success\",\n \"status\": \"Success\",\n \"_id\": \"64f660a8b28ab6001917d955\"\n }\n ]\n}"},{"id":"483cd427-61fa-4456-ba93-1ccb9c28c475","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"name\": \"620\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/products/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 04 Sep 2023 22:57:11 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"17"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"11-BmXyJR57V3HTR6Z9RoFXLee/9SE\""}],"cookie":[],"responseTime":null,"body":"Product malformed"}],"_postman_id":"38f2b7a2-5cbf-497b-9968-24549d5c2a91"},{"name":"Search products","id":"a09251b2-a55f-4fb9-925e-618911800742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/products/search","description":"Endpoint to retrieve information regarding available products
\n{\n \"query\": {\n \"manufacturer\": \"Amped\"\n },\n \"limit\": 1\n}\n\nLike for the other search queries, you can use the sort, limit and select MongoDb options to optimize your request. See MongoDb documentation for more details.
\nYou can use the additionnal field includeBoQ to request a populated build of quantities for each product.
{\n \"query\": {\n \"name\": \"Samsung A3\"\n },\n \"includeBoQ\": true\n}\n\nUse this endpoint to edit an existing product, specified by its productReference.
\n","urlObject":{"protocol":"https","path":["data","products"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"e71c3293-4f3e-44c6-857d-9c1a1da94f40","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicSet up endpoints. Your products are the type of goods that your company sells with Upya.
\n\n\nExample: Samsung S20
\n
Products can be serialized or non-serialized and lockable or non-lockable.
\nLockable products are products that can be remotely locked if the client doesn't pay for his/her device. The locking mechanism can be either time-based or communication-based.
\n","_postman_id":"1aa3985d-8583-4d9a-9688-3463c87aea67"},{"name":"Deals","item":[{"name":"Create deal","id":"0b5cea46-4240-4f40-81db-e21b6ad0da4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/deals/create","description":"Endpoint to create new deals (as an array) for products specified by their productReference.
\n","urlObject":{"protocol":"https","path":["data","deals","create"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"8d179bb5-18d1-4357-a498-c1abb02a2413","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\n \"type\": \"PAYG\",\n \"productReference\": \"1594202540734\",\n \"dealName\": \"New Paygo deal\",\n \"description\": \"Created by API call\",\n \"totalCost\": 10000,\n \"ccy\": \"MWK\",\n \"backPay\": \"On\",\n \"noQuestionnaireNeeded\": true,\n \"pricingSchedule\": {\n \"upfrontPayment\": 10000,\n \"upfrontDays\": 30,\n \"recurrentPayment\": 5000,\n \"freq\":30,\n \"minPayment\":5000\n }\n}]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/deals/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 10:32:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"436"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"1b4-M7ov8LeyFiJHZh9F5gTCLhegJPo\""},{"key":"Set-Cookie","value":"connect.sid=s%3Au6_PNxoOmORsaL82epPsIRQlDYay88qU.9phPvaleahkiJSfDpa06%2BME44dv7slJzOmtzhxGXPiU; Path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"invalidRequests\": [],\n \"results\": [\n {\n \"dealName\": \"New Paygo deal\",\n \"description\": \"Created by API call\",\n \"dealNumber\": \"XJ0SR\",\n \"type\": \"PAYG\",\n \"totalCost\": 10000,\n \"status\": \"Active\",\n \"ccy\": \"MWK\",\n \"backPay\": \"On\",\n \"lockable\": true,\n \"noQuestionnaireNeeded\": true,\n \"eligibleProduct\": {},\n \"pricingSchedule\": {\n \"recurring\": 5000,\n \"days\": 30,\n \"upfront\": 10000,\n \"upfrontDays\": 30,\n \"minPayment\": 5000\n },\n \"topUpSchedule\": {},\n \"setUpOn\": \"2023-09-05T10:32:57.580Z\",\n \"restrictedTo\": []\n }\n ]\n}"},{"id":"6fc100eb-29fc-4396-87f8-834d7e971c4c","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[{\n \"type\": \"PAYG\",\n \"name\": \"API deal\",\n \"description\": \"Created by API call\",\n \"totalCost\": 10000,\n \"ccy\": \"MWK\",\n \"backPay\": \"On\",\n \"noQuestionnaireNeeded\": true,\n \"pricingSchedule\": {\n \"upfrontPayment\": 10000,\n \"upfrontDays\": 30,\n \"recurrentPayment\": 5000,\n \"freq\":30,\n \"minPayment\":5000\n }\n}]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/deals/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 10:31:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"350"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"15e-D2oc8fiuT3CBSKKsmQoI83I7sb4\""},{"key":"Set-Cookie","value":"connect.sid=s%3Aj69u0MKmawWDBBonxns6AAVnQzZCJ2Yi.pHQTUe7Slpg1OM3bvyvHQiWPcvn4X827vZDMdA4xDic; Path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"invalidRequests\": [\n {\n \"error\": 400,\n \"message\": \"Incorrect productReference\",\n \"data\": {\n \"type\": \"PAYG\",\n \"name\": \"API deal\",\n \"description\": \"Created by API call\",\n \"totalCost\": 10000,\n \"ccy\": \"MWK\",\n \"backPay\": \"On\",\n \"noQuestionnaireNeeded\": true,\n \"pricingSchedule\": {\n \"upfrontPayment\": 10000,\n \"upfrontDays\": 30,\n \"recurrentPayment\": 5000,\n \"freq\": 30,\n \"minPayment\": 5000\n }\n }\n }\n ],\n \"results\": []\n}"}],"_postman_id":"0b5cea46-4240-4f40-81db-e21b6ad0da4e"},{"name":"Search deals","id":"9cf314ff-102e-461e-ab06-5987e89f8064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/deals/search","description":"Endpoint to retrieve list of deals available given provided criteria. Deals are the terms or payment plans under which you sell your different products.
\nYou can also use the following MongoDb options: sort, limit and select to optimize your request. See MongoDb documentation for more details
\nAdd a includeOldVersions flag set to true to include all deal versions in the answer. \"Old_version\" deals are not accessible by web or app users anymore.
{\n \"query\": {\n \"type\": \"PAYG\",\n \"status\":\"Active\"\n },\n \"limit\": 1,\n \"includeOldVersions\": true\n}\n\nEndpoint to edit a given deal specified by its dealNumber.
\nEditing any numerical value (totalCost, recurring payment, etc) with an economical impact will create a new deal version. Editing non-economic fields (dealName, description, etc) will not create a new deal version.
\nA new deal version only affects future customers picking the edited deal. Existing customers (including pending ones) will not be affected by an edit creating a new deal version.
\nYou can also restrict access to the deal to certain mobile app users, using the agentNumbersToAdd and agentNumbersToRemove fields.
\n","urlObject":{"protocol":"https","path":["data","deals"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"8806d91b-4ff6-4869-8101-70a3ab91531f","name":"success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dealNumber\": \"XJ0SR\",\n \"totalCost\": 150000,\n \"pricingSchedule\": {\n \"days\": 20,\n \"recurring\": 15000,\n \"upfront\": 5000,\n \"upfrontDays\": 3000\n },\n \"description\": \"Edited by API call\"\n}","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/deals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 10:40:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"453"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"1c5-neZpICDAjHrM3Ep9vTCzSpsh0wg\""},{"key":"Set-Cookie","value":"connect.sid=s%3An4Ll1gWwHVRcqc8ACEc43HsxkjIepeXp.EG5fAtAbdVQKrsLRrZqVsM1vP9lTDV4uIXFENhbOI54; Path=/; HttpOnly"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"result\": {\n \"dealName\": \"New Paygo deal\",\n \"description\": \"Edited by API call\",\n \"dealNumber\": \"XJ0SR\",\n \"type\": \"PAYG\",\n \"totalCost\": 150000,\n \"status\": \"Active\",\n \"ccy\": \"MWK\",\n \"backPay\": \"On\",\n \"lockable\": true,\n \"noQuestionnaireNeeded\": true,\n \"eligibleProduct\": {},\n \"pricingSchedule\": {\n \"recurring\": 15000,\n \"days\": 20,\n \"upfront\": 5000,\n \"upfrontDays\": 3000,\n \"minPayment\": 5000\n },\n \"topUpSchedule\": {},\n \"setUpOn\": \"2023-09-05T10:40:07.080Z\",\n \"restrictedTo\": []\n }\n}"}],"_postman_id":"dda23ecd-82cf-4f1e-8d8e-d06f80adb453"}],"id":"449a9037-19dc-4af9-96ac-5f78e6a38522","description":"Set up endpoints. Deals are the different pricing terms under which your company sells its products.
\nDeals can be of different types:
\nDeals also specify the onboarding process, behind selling product X under pricing terms Y. Along with the penalty regime for late payments and the offered warranty.
\n","_postman_id":"449a9037-19dc-4af9-96ac-5f78e6a38522"},{"name":"Tickets","item":[{"name":"Create tickets","id":"438b44cc-069c-4349-825f-97a2d870ed76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/tickets/create","description":"Endpoint to send tickets to web app users. Requires to have the \"task\" option activated and to have set up a \"ticket template\" in the Templates >> Set Up section of Manage.
\nUse an existing templateNumber and an existing userNumber.
\n","urlObject":{"protocol":"https","path":["data","tickets","create"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"438b44cc-069c-4349-825f-97a2d870ed76"},{"name":"Search tickets","id":"691470a8-35f2-486e-a8bb-a63b21423086","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/search/tickets","description":"Endpoint to search the ticket database. Pass through MongoDb-like queries in the body of the request
\n{\n \"query\": {\n \"createdAt\": {\n \"$gte\": \"05 September 2023\"\n }\n },\n \"paginate\":true,\n \"limit\":1\n}\n\nTickets are \"actions\" received by web users.
\n","_postman_id":"0fa4d2c9-58e0-4754-9d8a-33eae131e343"},{"name":"Tasks","item":[{"name":"Create tasks","id":"59273466-f3a1-4597-a451-5c82ac3f4514","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/tasks/create","description":"Endpoint to send tasks to mobile app users. Requires to have the \"task\" option activated and to have set up a \"task template\" in the Templates >> Set Up section of Manage.
\nTasks can be created in bulk.
\n","urlObject":{"protocol":"https","path":["data","tasks","create"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"28aadaf6-f555-4abc-9d45-27b7fce5e21c","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"templateNumber\": \"D9VKDIE0W\",\r\n \"agentNumber\": \"YE46H\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/tasks/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 19:34:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"6d-UDHszyqjIfOQ1M7o49yfEMNCqP0\""}],"cookie":[],"responseTime":null,"body":"{\n \"invalidRequests\": [],\n \"results\": [\n {\n \"templateNumber\": \"D9VKDIE0W\",\n \"taskNumber\": \"PMI17MB7Q\",\n \"status\": \"Success\"\n }\n ]\n}"},{"id":"ca633b90-3898-4007-ba28-2bd8b333d338","name":"error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"templateNumber\": \"D9VK0W\",\r\n \"agentNumber\": \"YE46H\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://data.upya.io/data/tasks/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Sep 2023 19:35:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"151"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Credentials, x-access-token"},{"key":"Cache-Control","value":"private, no-cache, no-store, must-revalidate"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"ETag","value":"W/\"97-Ea6AOItezfbQe6Mg+eq5yekWlYs\""}],"cookie":[],"responseTime":null,"body":"{\n \"invalidRequests\": [\n {\n \"error\": 400,\n \"message\": \"Incorrect or empty templateNumber\",\n \"data\": {\n \"templateNumber\": \"D9VK0W\",\n \"agentNumber\": \"YE46H\"\n }\n }\n ],\n \"results\": []\n}"}],"_postman_id":"59273466-f3a1-4597-a451-5c82ac3f4514"},{"name":"Search tasks","id":"e050b56d-45e1-4068-a35f-f569ccf4a9b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/search/tasks","description":"Endpoint to search the task database. Pass through MongoDb-like queries in the body of the request
\n{\n \"query\": {\n \"createdAt\": {\n \"$gte\": \"05 September 2023\"\n }\n },\n \"paginate\":true,\n \"limit\":1\n}\n\nTasks are \"actions\" assigned to mobile app users.
\n","_postman_id":"3b1de97b-266f-4ed3-9de6-7485829ea235"},{"name":"Events","item":[{"name":"Search contract events","id":"fc75a8f2-5472-4d6b-9a44-3603ffbca825","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://data.upya.io/data/search/contract-events","description":"Endpoint to search the contractEvent database. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","search","contract-events"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"86859c6d-e2cd-467d-b675-c63006740a11","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEndpoint to search the assetEvent database. Pass through MongoDb-like queries in the body of the request
\n","urlObject":{"protocol":"https","path":["data","search","asset-events"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[{"id":"e8b29d2e-3030-46af-8be4-a3b178e814fa","name":"success","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicOn Upya, changes to any client, unit or contract are monitored and logged as events. These events can be forwarded to webhooks as they occur (see the \"Webhook\" section).
\nAlternatively, you can query your clientEvents, contractEvents and assetEvents database.
\nThey are different types of contractEvents and assetEvents and these types can be divided between:
\nLife events types
\nUpdates events types
\nContractEvents life events types include:
\n\n\nSIGNED, SUBMITTED, REJECTED, APPROVED, WRITEOFF, UNWRITEOFF, REPOSSESSED, UNREPOSSESSED, ENABLED, LOCKED, PAIDOFF, FLAG, PAYMENT
\n
ContractEvents update events types include:
\n\n\n","_postman_id":"4bf8d3e0-d309-4dd5-a635-deeaf8fda5d7"},{"name":"Communicate","item":[{"name":"Send pop-up notification","id":"bd4b367f-c3b0-4807-b8dd-6db9e4319211","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/communication/notification","description":"DEAL_CHANGE, DEAL_UPDATE, REPLACED, MODIFIED, TRANSFERED, ADDED, REMOVED
\n
Send a pop up message, or \"notification\", to the mobile app of your agents. There is no charge for sending notifications.
\n","urlObject":{"protocol":"https","path":["data","communication","notification"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd4b367f-c3b0-4807-b8dd-6db9e4319211"},{"name":"Send chat message","id":"8510201f-aea1-4c55-bf43-1d755018dff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/communication/chat","description":"Send a message to the chat of a task or ticket. Specify either a ticketNumber or taskNumber.
\nThere is no charge for sending chat messages.
\n(*) at least one of taskNumber or ticketNumber must be specified
\n","urlObject":{"protocol":"https","path":["data","communication","chat"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"8510201f-aea1-4c55-bf43-1d755018dff5"},{"name":"Send text message","id":"c077057a-a70b-4273-923b-d2e011bbf368","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://data.upya.io/data/communication/message","description":"Send a text message to your clients or agents. Standard SMS charges apply.
\n(*) at lest of agentNumber or clientNumber must be specified
\n","urlObject":{"protocol":"https","path":["data","communication","message"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"c077057a-a70b-4273-923b-d2e011bbf368"}],"id":"bcb8b134-2212-4e10-a70b-cfebb9d35cbb","description":"Endpoints to communicate with your clients and agents
\n","_postman_id":"bcb8b134-2212-4e10-a70b-cfebb9d35cbb"},{"name":"Users","item":[{"name":"Search users","id":"ef8bba5c-0e74-4503-aaf1-94f1303a1b31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://data.upya.io/data/search/users","description":"Endpoint to get users. Pass through MongoDb-like queries in the body of the request.
\nYou can also use the following MongoDb options: sort and limit to optimize your request. See MongoDb documentation for more details. Select is not available for security reasons.
\n","urlObject":{"protocol":"https","path":["data","search","users"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef8bba5c-0e74-4503-aaf1-94f1303a1b31"},{"name":"Create users","id":"4a05ef5c-6404-417c-ae03-df68a6c40606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://data.upya.io/data/users","description":"Endpoint to create web platform users
\n","urlObject":{"protocol":"https","path":["data","users"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a05ef5c-6404-417c-ae03-df68a6c40606"},{"name":"Edit users","id":"0f0b7690-04c8-4480-b4a8-73ed36876998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://data.upya.io/data/users","description":"Endpoint to edit web platform users
\n","urlObject":{"protocol":"https","path":["data","users"],"host":["data","upya","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f0b7690-04c8-4480-b4a8-73ed36876998"}],"id":"72182123-58ea-4fac-a447-b29e0da6eb3c","description":"Users log in to the Manage web platform. Their credentials do not work on the mobile app.
\n","_postman_id":"72182123-58ea-4fac-a447-b29e0da6eb3c"},{"name":"Messages","item":[{"name":"Search messages","id":"4e832aaf-1e75-4516-8b19-2d3bfa622009","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://data.upya.io/data/search/messages","description":"Endpoint to search your message collection. Pass through MongoDb-like queries in the body of your request in the query attribute.
\n\n\nExample: to retrieve all forms completed for the \"Example\" questionnaire, send the following body:
\n
{\n \"query\": {\n \"date\": {$gte: \"01 August 2023\"}\n }\n}\n\nYou can also use the following MongoDb options: sort and limit to optimize your request. See MongoDb documentation for more details.
\nFinally, to paginate your answer, you can use the MongoDb skip option by adding the following attributes to your query: paginate, pageNumber and nPerPage. The skip option overrides any \"sort\" input for answer stability reasons.
\n{\n \"query\": {\n \"date\": {$gte: \"01 August 2023\"}\n },\n \"paginate\": true,\n \"pageNumber\": 2,\n \"nPerPage\": 1000\n}\n\n