{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api-contadores-hom.solutipro.com.br" } ], "info": { "name": "Soluti PRO - HOMOLOGA\u00c7\u00c3O", "_postman_id": "4070c4a5-d56c-477a-93c1-de0d144e59db", "description": "API Soluti PRO - HOMOLOGA\u00c7\u00c3O para integra\u00e7\u00e3o entre Frontend, Sistema de ARs e Bird ID.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "API", "description": "", "item": [ { "name": "Health", "description": "Recursos relacionados a sa\u00fade da API", "item": [ { "name": "Check", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health", "query": [], "raw": "{{baseUrl}}\/api\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint de Health Check", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"0\":{\"label\":\"DB\",\"status\":\"ok\"},\"1\":{\"label\":\"Schedule\",\"status\":\"ok\"},\"2\":{\"label\":\"REDIS Cache\",\"status\":\"ok\"},\"3\":{\"label\":\"Environment\",\"status\":\"ok\"},\"4\":{\"label\":\"RabbitMQ\",\"status\":\"ok\"},\"5\":{\"label\":\"Environment Variables Check\",\"status\":\"ok\"},\"6\":{\"label\":\"Octane\",\"status\":\"ok\"},\"7\":{\"label\":\"Debug Mode\",\"status\":\"ok\"},\"date\":1720198684}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] } ] } ] }, { "name": "V1", "description": "", "item": [ { "name": "Autentica\u00e7\u00e3o e Autoriza\u00e7\u00e3o", "description": "Recursos relacionados a Autentica\u00e7\u00e3o e Autoriza\u00e7\u00e3o da API", "item": [ { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Invalidar o Token." }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] }, { "name": "Refresh Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Gerar novo Token sem necessidade de uma nova autentica\u00e7\u00e3o." }, "response": [ { "header": [], "code": 200, "body": "{\"access_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0\",\"token_type\":\"Bearer\",\"expires_in\":86400}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"registration_number\":\"12345678919\",\"password\":[\"123456\",\"9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be\"]}" }, "description": "Realizar Autentica\u00e7\u00e3o na API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] }, { "name": "Autentica\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/birdid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/birdid" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"registration_number\":\"12345678919\",\"password\":[\"123456\",\"9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be\"]}" }, "description": "Realizar Autentica\u00e7\u00e3o na API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"access_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0\",\"token_type\":\"Bearer\",\"expires_in\":86400}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] }, { "name": "Autoriza\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/authorization", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/authorization" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Realizar Autoriza\u00e7\u00e3o na API." }, "response": [ { "header": [], "code": 200, "body": "{\"access_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0\",\"token_type\":\"Bearer\",\"expires_in\":86400}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" } ] } ] }, { "name": "Organiza\u00e7\u00e3o", "description": "Recursos relacionados a gerenciamento de Organiza\u00e7\u00f5es da API", "item": [ { "name": "Visualizar uma Organiza\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar uma Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"organization\":{\"id\":1,\"ulid\":\"01hska5h7gfzjh4vz9e2wa04m3\",\"status\":true,\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"uchoa.net.br\",\"email\":\"julia.alcantara@burgos.br\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"country_id\":181,\"state_id\":719,\"city_id\":281,\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Atualizar a Organiza\u00e7\u00e3o logada", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "PUT", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":true,\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"email\":\"julia.alcantara@burgos.br\",\"country_id\":\"181\",\"country_name\":\"Brasil\",\"state_id\":\"719\",\"state_name\":\"GO\",\"city_id\":\"281\",\"city_name\":\"Goi\u00e2nia\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"price_id\":\"1\",\"production_range_id\":\"1\"}" }, "description": "Endpoint para atualizar a Organiza\u00e7\u00e3o logada" }, "response": [ { "header": [], "code": 200, "body": "{\"organization\":{\"id\":1,\"ulid\":\"01hska5h7gfzjh4vz9e2wa04m3\",\"status\":true,\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"uchoa.net.br\",\"email\":\"julia.alcantara@burgos.br\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"country_id\":181,\"state_id\":719,\"city_id\":281,\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Listagem de Organiza\u00e7\u00f5es filhas", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/organizations", "query": [ { "key": "with_oldest_user", "value": "", "description": "", "disabled": true }, { "key": "with_users", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/organizations?with_oldest_user=&with_users=", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar as Organiza\u00e7\u00f5es filhas" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"ulid\":\"01hskavrd19b97zf0b0wza6mxg\",\"status\":true,\"type\":\"J\",\"registration_number\":\"23941629000131\",\"alias\":\"Faria e Campos e Filhos\",\"name\":\"Faria e Campos e Filhos\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"vieira.com\",\"email\":\"olivia.urias@fernandes.net\",\"phone\":\"(87) 94504-7332\",\"whatsapp\":\"(69) 95915-7641\",\"country_id\":355,\"state_id\":256,\"city_id\":487,\"address\":\"Travessa Gilberto, 12. Apto 43\",\"number\":\"108\",\"complement\":\"Bc. 54 Ap. 33\",\"neighborhood\":\"Sul\",\"postal_code\":\"43903-374\",\"oldest_user\":null,\"users\":[],\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]},{\"id\":2,\"ulid\":\"01hskavrdgra0ar5sbdvwytb1h\",\"status\":true,\"type\":\"J\",\"registration_number\":\"44622123000130\",\"alias\":\"Furtado e Teles Ltda.\",\"name\":\"Furtado e Teles Ltda.\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"valencia.com.br\",\"email\":\"lara12@vasques.br\",\"phone\":\"(86) 93579-7039\",\"whatsapp\":\"(24) 97955-1963\",\"country_id\":644,\"state_id\":24,\"city_id\":803,\"address\":\"Avenida Sergio, 13341\",\"number\":\"280\",\"complement\":\"Bloco A\",\"neighborhood\":\"Sul\",\"postal_code\":\"12398-085\",\"oldest_user\":null,\"users\":[],\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Cadastro de Organiza\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/organizations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/organizations", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"email\":\"julia.alcantara@burgos.br\",\"ar_subdomain\":\"arsoluti\",\"country_id\":\"181\",\"country_name\":\"Brasil\",\"state_id\":\"719\",\"state_name\":\"GO\",\"city_id\":\"281\",\"city_name\":\"Goi\u00e2nia\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"price_id\":\"1\",\"organization_type_code\":\"accounting\",\"products_skus\":[10,11,12],\"payment_modalities_code\":[\"PAYMENT_ACCOUNTING\",\"PAYMENT_CUSTOMER\",\"DEBIT_STOCK\",\"PRE_PAID_VOUCHER\",\"POST_PAID_VOUCHER\"],\"recaptcha-token\":\"dolorum\",\"users\":[{\"name\":\"Fulano de Tal\",\"email\":\"usuario@teste.com.br\",\"registration_number\":\"11122233344\",\"phone\":\"(11)99999-9999\",\"whatsapp\":\"(11)99999-9999\"}]}" }, "description": "Endpoint para cadastrar uma Organiza\u00e7\u00e3o FILHA" }, "response": [ { "header": [], "code": 201, "body": "{\"organization\":{\"id\":1,\"ulid\":\"01hska5h7gfzjh4vz9e2wa04m3\",\"status\":true,\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"ar_subdomain\":\"uchoa.net.br\",\"email\":\"julia.alcantara@burgos.br\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"country_id\":181,\"state_id\":719,\"city_id\":281,\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"production_range\":null,\"price\":null,\"products\":null,\"payment_modalities\":null}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Visualizar uma Organiza\u00e7\u00e3o filha", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/organizations\/:child_ulid", "query": [ { "key": "with_oldest_user", "value": "", "description": "", "disabled": true }, { "key": "with_users", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/organizations\/:child_ulid?with_oldest_user=&with_users=", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "child_ulid", "key": "child_ulid", "value": "01jx04hzemzdpx07k34bhers9b", "description": "ULID da Organiza\u00e7\u00e3o FILHA" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar uma Organiza\u00e7\u00e3o FILHA" }, "response": [ { "header": [], "code": 200, "body": "{\"organization\":{\"id\":1,\"ulid\":\"01hska5h7gfzjh4vz9e2wa04m3\",\"status\":true,\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"uchoa.net.br\",\"email\":\"julia.alcantara@burgos.br\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"country_id\":181,\"state_id\":719,\"city_id\":281,\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"oldest_user\":null,\"users\":[],\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Atualizar uma Organiza\u00e7\u00e3o filha", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/organizations\/:child_ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/organizations\/:child_ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "child_ulid", "key": "child_ulid", "value": "01jx04k797ntvq2p2azy8rycz9", "description": "ULID da Organiza\u00e7\u00e3o FILHA" } ] }, "method": "PUT", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":true,\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"email\":\"julia.alcantara@burgos.br\",\"country_id\":\"181\",\"country_name\":\"Brasil\",\"state_id\":\"719\",\"state_name\":\"GO\",\"city_id\":\"281\",\"city_name\":\"Goi\u00e2nia\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"price_id\":\"1\",\"production_range_id\":\"1\",\"users\":[{\"name\":\"Fulano de Tal\",\"email\":\"usuario@teste.com.br\",\"registration_number\":\"11122233344\",\"phone\":\"(11)99999-9999\",\"whatsapp\":\"(11)99999-9999\"}]}" }, "description": "Endpoint para atualizar uma Organiza\u00e7\u00e3o FILHA" }, "response": [ { "header": [], "code": 200, "body": "{\"organization\":{\"id\":1,\"ulid\":\"01hska5h7gfzjh4vz9e2wa04m3\",\"status\":true,\"type\":\"J\",\"registration_number\":\"19640726000117\",\"alias\":\"Aguiar e Associados\",\"name\":\"Aguiar e Associados\",\"ulid_ar\":\"01j5r7hmaar4gd1pssg0mv0erv\",\"ar_subdomain\":\"uchoa.net.br\",\"organization_type\":{\"ulid\":\"01j5r7hm75eh4mpvnhytzt8p2h\",\"status\":1,\"code\":\"accounting\",\"name\":\"Contabilidade\",\"created_at\":\"2024-08-20T12:00:00.000000Z\"},\"email\":\"julia.alcantara@burgos.br\",\"phone\":\"(97) 97317-3799\",\"whatsapp\":\"(75) 94533-8056\",\"country_id\":181,\"state_id\":719,\"city_id\":281,\"address\":\"Av. Carlos, 609. Bloco A\",\"number\":\"784\",\"complement\":\"Apto 5\",\"neighborhood\":\"Norte\",\"postal_code\":\"70033-161\",\"production_range\":null,\"price\":null,\"products\":[],\"payment_modalities\":[]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] } ] }, { "name": "Usu\u00e1rio", "description": "Recursos relacionados a gerenciamento de Usu\u00e1rios da API", "item": [ { "name": "Alterar usu\u00e1rio logado", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/users\/logged", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/users\/logged", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "PUT", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Fulano de Tal\",\"email\":\"email@email.com\",\"phone\":\"(11)99999-9999\"}" }, "description": "Endpoint para alterar o usu\u00e1rio logado" }, "response": [ { "header": [], "code": 200, "body": "{\"user\":{\"ulid\":\"01hskccmp33ztvmgf2aa4wcb2k\",\"name\":\"Dr. Vicente Velasques Sandoval\",\"email\":\"lourenco.kleber@example.net\",\"registration_number\":\"37194478200\",\"phone\":\"(62)99999-9999\",\"whatsapp\":\"(62)99999-9999\",\"bird_id\":{\"is_valid\":true,\"verified_at\":\"2025-06-25 16:39:42\"},\"videoconference\":{\"verification\":false,\"link\":\"https:\/\/roque.com\/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil\"},\"created_at\":\"2024-03-22T12:00:00.000000Z\",\"updated_at\":\"2024-03-22T12:00:00.000000Z\"}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Buscar dados do usu\u00e1rio logado", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/users\/logged", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/users\/logged", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para buscar dados do usu\u00e1rio logado" }, "response": [ { "header": [], "code": 200, "body": "{\"user\":{\"ulid\":\"01hskccmp33ztvmgf2aa4wcb2k\",\"name\":\"Dr. Vicente Velasques Sandoval\",\"email\":\"lourenco.kleber@example.net\",\"registration_number\":\"37194478200\",\"phone\":\"(62)99999-9999\",\"whatsapp\":\"(62)99999-9999\",\"bird_id\":{\"is_valid\":true,\"verified_at\":\"2025-06-25 16:39:42\"},\"videoconference\":{\"verification\":false,\"link\":\"https:\/\/roque.com\/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil\"},\"created_at\":\"2024-03-22T12:00:00.000000Z\",\"updated_at\":\"2024-03-22T12:00:00.000000Z\"}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Buscar usu\u00e1rio por CPF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/users\/:registration_number", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/users\/:registration_number", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "registration_number", "key": "registration_number", "value": "37194478200", "description": "CPF do Usu\u00e1rio" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para buscar um usu\u00e1rio por CPF" }, "response": [ { "header": [], "code": 200, "body": "{\"user\":{\"ulid\":\"01hskccmp33ztvmgf2aa4wcb2k\",\"name\":\"Dr. Vicente Velasques Sandoval\",\"email\":\"lourenco.kleber@example.net\",\"registration_number\":\"37194478200\",\"phone\":\"(62)99999-9999\",\"whatsapp\":\"(62)99999-9999\",\"bird_id\":{\"is_valid\":true,\"verified_at\":\"2025-06-25 16:39:42\"},\"videoconference\":{\"verification\":false,\"link\":\"https:\/\/roque.com\/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil\"},\"created_at\":\"2024-03-22T12:00:00.000000Z\",\"updated_at\":\"2024-03-22T12:00:00.000000Z\"}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Empresa", "description": "Recursos relacionados a gerenciamento de Empresas vinculadas a uma Organiza\u00e7\u00e3o da API", "item": [ { "name": "Listagem de Empresas", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/companies", "query": [ { "key": "filter", "value": "", "description": "Filtro do autocomplete, CPF\/CNPJ ou Nome", "disabled": true }, { "key": "order[column]", "value": "name", "description": "Tipos de Ordena\u00e7\u00e3o. consiste em um array, contendo coluna e dire\u00e7\u00e3o.", "disabled": false }, { "key": "order[direction]", "value": "asc", "description": "Tipos de Ordena\u00e7\u00e3o. consiste em um array, contendo coluna e dire\u00e7\u00e3o.", "disabled": false }, { "key": "order.column", "value": "aut", "description": "", "disabled": false }, { "key": "order.direction", "value": "quaerat", "description": "", "disabled": false }, { "key": "status", "value": "consequatur", "description": "Filtrar empresas ativas\/inativas", "disabled": false }, { "key": "customers", "value": "repellendus", "description": "Retorna os representantes legais da Empresa", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/companies?filter=&order[column]=name&order[direction]=asc&order.column=aut&order.direction=quaerat&status=consequatur&customers=repellendus", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar todos, ou por filtro, os clientes da Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"ulid\":\"01hsk870t6gvtst3jnckpn6wwk\",\"status\":true,\"type\":\"J\",\"registration_number\":\"44252837000101\",\"alias\":\"Rezende Comercial Ltda.\",\"name\":\"Rezende Comercial Ltda.\",\"email\":\"epaz@balestero.br\",\"phone\":\"(48) 98832-7335\",\"whatsapp\":\"(18) 92050-9242\",\"country_id\":846,\"country_name\":\"Brasil\",\"state_id\":397,\"state_name\":\"GO\",\"city_id\":196,\"city_name\":\"Goi\\u00e2nia\",\"address\":\"Travessa Ramos, 33\",\"number\":\"60000\",\"complement\":\"7\\u00ba Andar\",\"neighborhood\":\"Sudeste\",\"postal_code\":\"93870-423\",\"all_customers_has_birdid\":true},{\"id\":2,\"ulid\":\"01hsk870t935n40efhse53367j\",\"status\":true,\"type\":\"J\",\"registration_number\":\"18978565000103\",\"alias\":\"das Neves e Maia\",\"name\":\"das Neves e Maia\",\"email\":\"xdominato@cervantes.org\",\"phone\":\"(16) 99475-0159\",\"whatsapp\":\"(73) 93418-7121\",\"country_id\":846,\"country_name\":\"Brasil\",\"state_id\":397,\"state_name\":\"GO\",\"city_id\":196,\"city_name\":\"Goi\\u00e2nia\",\"address\":\"Rua Toledo, 5350. F\",\"number\":\"2\",\"complement\":\"2\\u00ba Andar\",\"neighborhood\":\"Norte\",\"postal_code\":\"73813-996\",\"all_customers_has_birdid\":false}],\"links\":{\"first\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=1\",\"last\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=2\",\"prev\":null,\"next\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"active\":false},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=1\",\"label\":\"1\",\"active\":true},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=2\",\"label\":\"2\",\"active\":false},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies?page=2\",\"label\":\"Pr\\u00f3ximo »\",\"active\":false}],\"path\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03k23s2qx6qs7y7s20c6t5\/companies\",\"per_page\":1,\"to\":10,\"total\":2}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Cadastro de Empresa", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/companies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/companies", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"J\",\"registration_number\":\"58312998000140\",\"alias\":\"Barreto e Rodrigues e Filhos\",\"name\":\"Barreto e Rodrigues e Filhos\",\"phone\":\"(87) 90410-2583\",\"whatsapp\":\"(22) 98676-2512\",\"email\":\"murilo63@abreu.com\",\"country_id\":\"846\",\"country_name\":\"Brasil\",\"state_id\":\"397\",\"state_name\":\"GO\",\"city_id\":\"196\",\"city_name\":\"Goi\u00e2nia\",\"neighborhood\":\"Sul\",\"postal_code\":\"95765-846\",\"address\":\"Largo Renan, 2. Bloco C\",\"number\":\"68111\",\"complement\":\"Bc. 8 Ap. 47\",\"customer\":{\"name\":\"Fulano de Tal\",\"email\":\"fulano@email.com\",\"registration_number\":\"81282527045\",\"phone\":\"(62)98178-0000\",\"whatsapp\":\"(11)99999-9999\"}}" }, "description": "Endpoint para cadastrar uma Empresa vinculada a uma Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 201, "body": "{\"company\":{\"id\":1,\"ulid\":\"01hsk7nf8s05cgr9ewyx6xj39c\",\"status\":true,\"type\":\"J\",\"registration_number\":\"58312998000140\",\"alias\":\"Barreto e Rodrigues e Filhos\",\"name\":\"Barreto e Rodrigues e Filhos\",\"email\":\"murilo63@abreu.com\",\"phone\":\"(87) 90410-2583\",\"whatsapp\":\"(22) 98676-2512\",\"country_id\":846,\"state_id\":397,\"city_id\":196,\"address\":\"Largo Renan, 2. Bloco C\",\"number\":\"68111\",\"complement\":\"Bc. 8 Ap. 47\",\"neighborhood\":\"Sul\",\"postal_code\":\"95765-846\",\"customers\":[{\"id\":1,\"ulid\":\"01hsf065qevt1176yz3cgtk118\",\"status\":true,\"registration_number\":\"81282527045\",\"name\":\"Fulano de Tal\",\"email\":\"fulano@gmail.com\",\"phone\":\"(62)98178-0000\",\"whatsapp\":\"(62)98178-0000\",\"bird_id\":{\"is_valid\":false,\"verified_at\":\"2024-04-23 15:09:50\"},\"videoconference\":{\"verification\":false,\"link\":null}}]}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Visualizar uma Empresa", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/companies\/:company_ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/companies\/:company_ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "company_ulid", "key": "company_ulid", "value": "01jx03kv1m7fccbs5brakp82rq", "description": "ULID da Empresa" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para visualizar uma Empresa vinculada a uma Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"company\":{\"id\":1,\"ulid\":\"01hsk7nf8s05cgr9ewyx6xj39c\",\"status\":true,\"type\":\"J\",\"registration_number\":\"58312998000140\",\"alias\":\"Barreto e Rodrigues e Filhos\",\"name\":\"Barreto e Rodrigues e Filhos\",\"email\":\"murilo63@abreu.com\",\"phone\":\"(87) 90410-2583\",\"whatsapp\":\"(22) 98676-2512\",\"country_id\":846,\"country_name\":\"Brasil\",\"state_id\":397,\"state_name\":\"GO\",\"city_id\":196,\"city_name\":\"Goi\\u00e2nia\",\"address\":\"Largo Renan, 2. Bloco C\",\"number\":\"68111\",\"complement\":\"Bc. 8 Ap. 47\",\"neighborhood\":\"Sul\",\"postal_code\":\"95765-846\",\"customers\":[{\"id\":1,\"ulid\":\"01hsf065qevt1176yz3cgtk118\",\"status\":true,\"registration_number\":\"81282527045\",\"name\":\"Fulano de Tal\",\"email\":\"fulano@gmail.com\",\"phone\":\"(62)98178-0000\",\"whatsapp\":\"(62)98178-0000\",\"bird_id\":{\"is_valid\":false,\"verified_at\":\"2024-04-23 15:09:50\"},\"videoconference\":{\"verification\":false,\"link\":null}}]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Atualiza\u00e7\u00e3o de Empresas", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/companies\/:company_ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/companies\/:company_ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "company_ulid", "key": "company_ulid", "value": "01jx03mfwftwchtreyczb5q497", "description": "ULID da Empresa" } ] }, "method": "PUT", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":true,\"alias\":\"Barreto e Rodrigues e Filhos\",\"name\":\"Barreto e Rodrigues e Filhos\",\"phone\":\"(87) 90410-2583\",\"whatsapp\":\"(22) 98676-2512\",\"email\":\"murilo63@abreu.com\",\"country_id\":\"846\",\"country_name\":\"Brasil\",\"state_id\":\"397\",\"state_name\":\"GO\",\"city_id\":\"196\",\"city_name\":\"Goi\u00e2nia\",\"neighborhood\":\"Sul\",\"postal_code\":\"95765-846\",\"address\":\"Largo Renan, 2. Bloco C\",\"number\":\"68111\",\"complement\":\"Bc. 8 Ap. 47\",\"customers\":[{\"name\":\"Fulano de Tal\",\"email\":\"fulano@email.com\",\"registration_number\":\"81282527045\",\"phone\":\"(62)98178-0000\",\"status\":true},{\"name\":\"Beltrano de Tal\",\"email\":\"beltrano@email.com\",\"registration_number\":\"81282527045\",\"phone\":\"(62)98178-0000\",\"status\":false}]}" }, "description": "Endpoint para atualizar uma Empresa vinculada a uma Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"company\":{\"id\":1,\"ulid\":\"01hsk7nf8s05cgr9ewyx6xj39c\",\"status\":true,\"type\":\"J\",\"registration_number\":\"58312998000140\",\"alias\":\"Barreto e Rodrigues e Filhos\",\"name\":\"Barreto e Rodrigues e Filhos\",\"email\":\"murilo63@abreu.com\",\"phone\":\"(87) 90410-2583\",\"whatsapp\":\"(22) 98676-2512\",\"country_id\":846,\"state_id\":397,\"city_id\":196,\"address\":\"Largo Renan, 2. Bloco C\",\"number\":\"68111\",\"complement\":\"Bc. 8 Ap. 47\",\"neighborhood\":\"Sul\",\"postal_code\":\"95765-846\"}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Desativar Empresa", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/companies\/:company_ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/companies\/:company_ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "company_ulid", "key": "company_ulid", "value": "01jx03j9vmtydhyh2ba8h8ezw7", "description": "ULID da Empresa" } ] }, "method": "DELETE", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para desativar a Empresa de uma Organiza\u00e7\u00e3o" }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "No Content" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Cliente", "description": "Recursos relacionados a gerenciamento de Organiza\u00e7\u00f5es da API", "item": [ { "name": "Validar Bird Id Cliente", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/customers\/:registration_number\/validate-birdid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/customers\/:registration_number\/validate-birdid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx03nn8zg7pyg28408sk73am", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "registration_number", "key": "registration_number", "value": "37194478200", "description": "CPF do Usu\u00e1rio" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para validar Bird ID do Cliente." }, "response": [ { "header": [], "code": 200, "body": "{\"bird_id\":{\"is_valid\":true}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Enviar e-mail de Videoconfer\u00eancia", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/customers\/:customer_ulid\/send-video-conference-link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/customers\/:customer_ulid\/send-video-conference-link", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx03n1dy9b7eqq4xs8h8zj87", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "customer_ulid", "key": "customer_ulid", "value": "01jx03nadphsr85f8kh70tehac", "description": "ULID do Cliente" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para enviar e-mail com link de Videoconfer\u00eancia para o Cliente." }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] } ] }, { "name": "Faixa de Produ\u00e7\u00e3o", "description": "Recursos relacionados a gerenciamento de Faixa de Produ\u00e7\u00e3o da API", "item": [ { "name": "Cadastro de Faixa de Produ\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/production-ranges", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/production-ranges", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"1 at\u00e9 100\",\"start\":1,\"end\":100,\"status\":true}" }, "description": "Endpoint para cadastrar uma faixa de produ\u00e7\u00e3o (Organiza\u00e7\u00e3o do tipo AR)" }, "response": [ { "header": [], "code": 201, "body": "{\"production_range\":{\"id\":1,\"slug\":\"1-ate-100\",\"start\":1,\"end\":100,\"status\":true,\"description\":\"1 at\\u00e9 100\"}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Lista Faixa de Produ\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/production-ranges", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/production-ranges", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar as faixas de produ\u00e7\u00f5es associada a uma AR" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"slug\":\"1-ate-100\",\"start\":1,\"end\":100,\"status\":true,\"description\":\"1 at\\u00e9 100\"},{\"id\":2,\"slug\":\"101-ate-300\",\"start\":101,\"end\":300,\"status\":true,\"description\":\"101 at\\u00e9 300\"},{\"id\":3,\"slug\":\"301-ate-500\",\"start\":301,\"end\":500,\"status\":true,\"description\":\"301 at\\u00e9 500\"}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Atualizar Faixa de Produ\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/production-ranges\/:production_range_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/production-ranges\/:production_range_id", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "production_range_id", "key": "production_range_id", "value": "1", "description": "ID da Faixa de Produ\u00e7\u00e3o" } ] }, "method": "PUT", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"1 at\u00e9 100\",\"status\":true,\"start\":1,\"end\":100}" }, "description": "Endpoint para cadastrar uma faixa de produ\u00e7\u00e3o (Organiza\u00e7\u00e3o do tipo AR)" }, "response": [ { "header": [], "code": 201, "body": "{\"production_range\":{\"id\":1,\"slug\":\"1-ate-100\",\"start\":1,\"end\":100,\"status\":true,\"description\":\"1 at\\u00e9 100\"}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] } ] }, { "name": "Tabela de Pre\u00e7o", "description": "Recursos relacionados a gerenciamento de Tabela de Pre\u00e7os", "item": [ { "name": "Cadastro de Pre\u00e7os", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/prices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/prices", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Pre\u00e7o Teste\",\"details\":[{\"pre_cost\":\"10.99\",\"pre_sale\":\"15.99\",\"post_cost\":\"12.99\",\"post_sale\":\"17.99\",\"product_id\":1,\"production_range_id\":1},{\"pre_cost\":\"10.99\",\"pre_sale\":\"15.99\",\"post_cost\":\"12.99\",\"post_sale\":\"17.99\",\"product_id\":2,\"production_range_id\":1}]}" }, "description": "Endpoint para cadastrar um pre\u00e7o com seus detalhes" }, "response": [ { "header": [], "code": 201, "body": "{\"price\":{\"id\":1,\"name\":\"Pre\\u00e7o Teste\",\"slug\":\"preco-teste\",\"status\":\"Rascunho\",\"start_date\":\"2025-06-05T12:00:00.000000Z\",\"end_date\":null,\"link\":\"LINK_DOWNLOAD_PLANILHA\"}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Calcular Pre\u00e7os dos Produtos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/prices\/calculate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/prices\/calculate", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"products\":[{\"product_id\":1,\"quantity\":21}]}" }, "description": "Endpoint para calcular os pre\u00e7os dos produtos informados atrav\u00e9s do quantidade relacionada a faixa de produ\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"production_range\":{\"id\":2,\"slug\":\"11-a-20\",\"start\":11,\"end\":20,\"status\":true,\"description\":\"11 a 20\"},\"products\":[{\"id\":1,\"quantity\":21,\"name\":\"Certificado PJ A1 - Spro Contadores\",\"validate\":1,\"status\":true,\"price\":{\"value_unit_origin\":\"119.90\",\"value_unit_current\":\"109.90\",\"amount_origin\":\"2517.90\",\"amount_current\":\"2307.90\"}}],\"totals\":{\"total_origin\":\"2517.90\",\"total_current\":\"2307.90\",\"discounts\":\"210.00\"},\"details\":null}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] } ] }, { "name": "Modalidades de Pagamento", "description": "Recursos relacionados a gerenciamento de Modalidades de Pagamento da API", "item": [ { "name": "Lista Modalidades de Pagamento", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/payment-modalities", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/payment-modalities", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar todos os modalidades de pagamentos" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"name\":\"Pagamento feito pela contabilidade\",\"code\":\"PAYMENT_ACCOUNTING\",\"status\":true,\"negotiations\":[],\"main_negotiation\":[],\"created_at\":\"2024-06-28T12:00:00.000000Z\",\"updated_at\":\"2024-06-28T12:00:00.000000Z\"},{\"id\":2,\"name\":\"Pagamento feito pelo cliente\",\"code\":\"PAYMENT_CUSTOMER\",\"status\":true,\"negotiations\":[],\"main_negotiation\":[],\"created_at\":\"2024-06-28T12:00:00.000000Z\",\"updated_at\":\"2024-06-28T12:00:00.000000Z\"},{\"id\":3,\"name\":\"Utiliza\\u00e7\\u00e3o da minha Reserva\",\"code\":\"DEBIT_STOCK\",\"status\":true,\"negotiations\":[],\"main_negotiation\":[],\"created_at\":\"2024-06-28T12:00:00.000000Z\",\"updated_at\":\"2024-07-01T12:00:00.000000Z\"},{\"id\":4,\"name\":\"Utilizar voucher pr\\u00e9-pago\",\"code\":\"PRE_PAID_VOUCHER\",\"status\":true,\"negotiations\":[{\"label\":\"Contrato Pr\\u00e9 Pago 2\",\"negotiation\":\"987654321\",\"order\":1},{\"label\":\"Contrato Pr\\u00e9 Pago 1\",\"negotiation\":\"123456789\",\"order\":2}],\"main_negotiation\":{\"label\":\"Contrato Pr\\u00e9 Pago 2\",\"negotiation\":\"987654321\",\"order\":1},\"created_at\":\"2024-06-28T12:00:00.000000Z\",\"updated_at\":\"2024-07-01T12:00:00.000000Z\"},{\"id\":5,\"name\":\"Utilizar voucher p\\u00f3s-pago\",\"code\":\"POST_PAID_VOUCHER\",\"status\":true,\"negotiations\":[{\"label\":\"Contrato P\\u00f3s Pago 1\",\"negotiation\":\"1234XPTO\",\"order\":1},{\"label\":\"Contrato P\\u00f3s Pago 2\",\"negotiation\":\"XPTO1234\",\"order\":2}],\"main_negotiation\":{\"label\":\"Contrato P\\u00f3s Pago 1\",\"negotiation\":\"1234XPTO\",\"order\":1},\"created_at\":\"2024-06-28T12:00:00.000000Z\",\"updated_at\":\"2024-07-01T12:00:00.000000Z\"}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Verificar Saldo (Negocia\u00e7\u00e3o SDeal)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/payment-modalities\/negotiation\/check-balance", "query": [ { "key": "registration_number", "value": "56539899000170", "description": "CNPJ da Organiza\u00e7\u00e3o", "disabled": false }, { "key": "negotiation", "value": "160222", "description": "Negocia\u00e7\u00e3o SDeal", "disabled": false }, { "key": "type", "value": "PRE", "description": "Modelo da Negocia\u00e7\u00e3o SDeal", "disabled": false }, { "key": "sku", "value": "10", "description": "SKU do Produto", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/payment-modalities\/negotiation\/check-balance?registration_number=56539899000170&negotiation=160222&type=PRE&sku=10", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para verificar o saldo da negocia\u00e7\u00e3o SDeal para modalidade de pagamento" }, "response": [ { "header": [], "code": 200, "body": "{\"balance\":10}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "M\u00e9todos de Pagamento", "description": "Recursos relacionados a gerenciamento de M\u00e9todos de Pagamento da API", "item": [ { "name": "Lista m\u00e9todos de pagamento", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/payment-methods", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/payment-methods", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar todos os m\u00e9todos de pagamentos" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"name\":\"Cart\\u00e3o de Cr\\u00e9dito\",\"code\":\"CREDIT_CARD\",\"status\":true,\"created_at\":\"2024-08-20T12:00:00.000000Z\",\"updated_at\":\"2024-08-20T12:00:00.000000Z\"},{\"id\":2,\"name\":\"Boleto Banc\\u00e1rio\",\"code\":\"DEPOSIT\",\"status\":true,\"created_at\":\"2024-08-20T12:00:00.000000Z\",\"updated_at\":\"2024-08-20T12:00:00.000000Z\"},{\"id\":3,\"name\":\"PIX\",\"code\":\"PIX\",\"status\":true,\"created_at\":\"2024-08-20T12:00:00.000000Z\",\"updated_at\":\"2024-08-20T12:00:00.000000Z\"}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Produtos", "description": "Recursos relacionados a gerenciamento de Produtos da API", "item": [ { "name": "Lista produtos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/products", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar todos os produtos ativos" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-27T12:00:00.000000Z\",\"updated_at\":\"2024-05-27T12:00:00.000000Z\"}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Campos Din\u00e2mico", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/products\/fields", "query": [ { "key": "sku", "value": "19052", "description": "SKU do produto", "disabled": false }, { "key": "product_id", "value": "147", "description": "ID do produto no SisAR", "disabled": false }, { "key": "only_required", "value": "", "description": "Filtrar somente campos din\u00e2micos obrigat\u00f3rios", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/products\/fields?sku=19052&product_id=147&only_required=", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para retornar os campos din\u00e2micos vindos do SisAR" }, "response": [ { "header": [], "code": 200, "body": "{\"product\":{\"id\":\"768\",\"name\":\"ACS PJ A1 V5 G2 - SPRO CONTADORES\",\"social_name\":\"CERTIFICADO PJ A1 SPRO CONTADORES\",\"type\":\"J\",\"policy\":\"A1\",\"class\":\"PJ\",\"profile\":\"legal_person\",\"months_validity\":\"12\",\"certificate_authority\":\"AC SOLUTI M v5 TESTE\",\"issuer\":{\"url\":\"https:\/\/arsolutihom.acsoluti.com.br\/site\/emitircertificado\/\"},\"fields\":{\"legal_person\":{\"physical_person\":[{\"id\":\"name\",\"name\":\"name_pf\",\"label\":\"Nome\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":3,\"max_length\":200,\"placeholder\":\"Titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"social_name\",\"name\":\"social_name\",\"label\":\"Nome social\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":3,\"max_length\":200,\"placeholder\":\"Nome social do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"cpf\",\"name\":\"cpf\",\"label\":\"CPF\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":11,\"max_length\":11,\"placeholder\":\"CPF do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"birthday\",\"name\":\"birthday\",\"label\":\"Data de nascimento\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":10,\"max_length\":10,\"placeholder\":\"Data de nascimento do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"rg_number\",\"name\":\"rg_number\",\"label\":\"RG (n\\u00famero)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":15,\"placeholder\":\"RG (n\\u00famero) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"rg_organ\",\"name\":\"rg_organ\",\"label\":\"RG (expedidor)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":8,\"placeholder\":\"RG (expedidor) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"rg_uf\",\"name\":\"rg_uf\",\"label\":\"RG (UF)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":2,\"max_length\":2,\"placeholder\":\"RG (UF) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"te_number\",\"name\":\"te_number\",\"label\":\"T\\u00edtulo de eleitor (n\\u00famero)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":12,\"placeholder\":\"T\\u00edtulo de eleitor (n\\u00famero) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"te_zone\",\"name\":\"te_zone\",\"label\":\"T\\u00edtulo de eleitor (zona eleitoral)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":3,\"placeholder\":\"T\\u00edtulo de eleitor (zona eleitoral) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"te_section\",\"name\":\"te_section\",\"label\":\"T\\u00edtulo de eleitor (se\\u00e7\\u00e3o eleitoral)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":4,\"placeholder\":\"T\\u00edtulo de eleitor (se\\u00e7\\u00e3o eleitoral) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"te_city\",\"name\":\"te_city\",\"label\":\"T\\u00edtulo de eleitor (munic\\u00edpio)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":20,\"placeholder\":\"T\\u00edtulo de eleitor (munic\\u00edpio) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"te_uf\",\"name\":\"te_uf\",\"label\":\"T\\u00edtulo de eleitor (UF)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":2,\"placeholder\":\"T\\u00edtulo de eleitor (UF) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"cnh\",\"name\":\"cnh\",\"label\":\"CNH\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":12,\"placeholder\":\"CNH do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"cei\",\"name\":\"cei\",\"label\":\"CEI\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":12,\"placeholder\":\"Cadastrado Espec\\u00edfico do INSS\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"pis\",\"name\":\"pis\",\"label\":\"PIS\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":11,\"placeholder\":\"N\\u00famero do PIS (Programa de Integra\\u00e7\\u00e3o Social)\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"phone\",\"name\":\"phone\",\"label\":\"Celular\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":11,\"max_length\":11,\"placeholder\":\"Celular do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"email\",\"name\":\"email\",\"label\":\"E-mail\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":5,\"max_length\":100,\"placeholder\":\"E-mail do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"email_cc\",\"name\":\"email_cc\",\"label\":\"E-mail Adicional\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":5,\"max_length\":100,\"placeholder\":\"E-mail adicional\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"upn\",\"name\":\"upn\",\"label\":\"UPN (login)\",\"value\":\"\",\"required\":false,\"disable\":false,\"min_length\":0,\"max_length\":100,\"placeholder\":\"UPN (login) do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"id_city\",\"name\":\"ibge_county\",\"label\":\"C\\u00f3digo IBGE\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":1,\"max_length\":7,\"placeholder\":\"Munic\\u00edpio do titular do Certificado\",\"type\":\"text\",\"values\":null,\"tooltip\":null}],\"legal_person\":[{\"id\":\"name\",\"name\":\"name_pj\",\"label\":\"Raz\\u00e3o Social\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":3,\"max_length\":200,\"placeholder\":\"Raz\\u00e3o Social\",\"type\":\"text\",\"values\":null,\"tooltip\":null},{\"id\":\"cnpj\",\"name\":\"cnpj\",\"label\":\"CNPJ\",\"value\":\"\",\"required\":true,\"disable\":false,\"min_length\":14,\"max_length\":14,\"placeholder\":\"CNPJ da Empresa\",\"type\":\"text\",\"values\":null,\"tooltip\":null}]}}}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Negocia\u00e7\u00e3o", "description": "Recursos relacionados a gerenciamento de Negocia\u00e7\u00f5es da API", "item": [ { "name": "Listagem de Negocia\u00e7\u00f5es", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders", "query": [ { "key": "status", "value": "", "description": "Status da Negocia\u00e7\u00e3o", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders?status=", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar as Negocia\u00e7\u00f5es" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"ulid\":\"01hz7rvnvaxfy0g5e9pnh0snpr\",\"type\":\"purchase_order\",\"public_token\":null,\"order_id\":null,\"order_code\":null,\"status\":{\"id\":1,\"code\":\"new\",\"label\":\"Novo\"},\"force_videoconference\":false,\"status_date\":\"2024-05-31T12:00:00.000000Z\",\"obs\":null,\"payment_modality\":{\"id\":1,\"name\":\"PAYMENT_ACCOUTING\",\"code\":\"INDIVIDUAL_SALE\",\"status\":true,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"payment_method\":null,\"company\":{\"id\":2,\"ulid\":\"01hz7rpnnfdn3mhbdg3ktzbeqh\",\"status\":true,\"type\":\"F\",\"registration_number\":\"20261104330\",\"alias\":\"Dr. Kevin Cl\\u00e9ber Mascarenhas\",\"name\":\"Dr. Kevin Cl\\u00e9ber Mascarenhas\",\"email\":\"beltrao.talita@matos.com\",\"phone\":\"(95) 92039-2234\",\"whatsapp\":\"(74) 99868-3791\",\"country_id\":537,\"country_name\":\"Brasil\",\"state_id\":416,\"state_name\":\"GO\",\"city_id\":953,\"city_name\":\"Senador Canedo\",\"address\":\"Largo Abreu, 85. 859\\u00ba Andar\",\"number\":\"8\",\"complement\":\"Apto 729\",\"neighborhood\":\"Nordeste\",\"postal_code\":\"73427-169\",\"all_customers_has_birdid\":null},\"customer\":{\"id\":8,\"ulid\":\"01hz7rpnnt9w8yaffzg9rmzkwm\",\"status\":true,\"registration_number\":\"58555228220\",\"name\":\"Dr. Cristiano de Arruda Quintana Jr.\",\"email\":\"qlourenco@example.org\",\"phone\":\"97950235969\",\"whatsapp\":\"32967501838\",\"bird_id\":{\"is_valid\":false,\"verified_at\":\"2024-05-31 13:46:06\"},\"videoconference\":{\"verification\":false,\"link\":\"http:\/\/tamoio.com\/et-et-ut-hic-deserunt-sint.html\"}},\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":null,\"amount\":\"1810.53\",\"details\":[{\"id\":1,\"product\":{\"id\":3,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":2,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"12.81\",\"additional_unit_value\":\"4.37\",\"final_unit_value\":\"17.18\",\"quantity\":3,\"amount\":\"51.54\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":2,\"product\":{\"id\":3,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":2,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"26.35\",\"additional_unit_value\":\"6.49\",\"final_unit_value\":\"32.84\",\"quantity\":11,\"amount\":\"361.24\",\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":3,\"product\":{\"id\":3,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":2,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"19.72\",\"additional_unit_value\":\"9.93\",\"final_unit_value\":\"29.65\",\"quantity\":3,\"amount\":\"88.95\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":4,\"product\":{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"37.67\",\"additional_unit_value\":\"5.37\",\"final_unit_value\":\"43.04\",\"quantity\":12,\"amount\":\"516.48\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":5,\"product\":{\"id\":2,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":1,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"24.83\",\"additional_unit_value\":\"2.70\",\"final_unit_value\":\"27.53\",\"quantity\":4,\"amount\":\"110.12\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":6,\"product\":{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"1.32\",\"additional_unit_value\":\"2.64\",\"final_unit_value\":\"3.96\",\"quantity\":17,\"amount\":\"67.32\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":7,\"product\":{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"37.30\",\"additional_unit_value\":\"4.07\",\"final_unit_value\":\"41.37\",\"quantity\":4,\"amount\":\"165.48\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":8,\"product\":{\"id\":6,\"certificate_type\":\"A3\",\"person_type\":\"PF\",\"sku\":11,\"sisar_id\":4,\"name\":\"Certificado PF A3\",\"validate\":1,\"description\":\"Certificado PF A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"33.18\",\"additional_unit_value\":\"4.27\",\"final_unit_value\":\"37.45\",\"quantity\":12,\"amount\":\"449.40\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"}]},{\"id\":2,\"ulid\":\"01hz7rvnvzs16xbr4z6qx2j048\",\"type\":\"purchase_order\",\"public_token\":null,\"order_id\":null,\"order_code\":null,\"status\":{\"id\":2,\"code\":\"payment_pending\",\"label\":\"Aguardando Pagamento\"},\"force_videoconference\":true,\"status_date\":\"2024-05-31T12:00:00.000000Z\",\"obs\":null,\"payment_modality\":{\"id\":1,\"name\":\"PAYMENT_ACCOUTING\",\"code\":\"INDIVIDUAL_SALE\",\"status\":true,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"payment_method\":null,\"company\":{\"id\":2,\"ulid\":\"01hz7rpnnfdn3mhbdg3ktzbeqh\",\"status\":true,\"type\":\"F\",\"registration_number\":\"20261104330\",\"alias\":\"Dr. Kevin Cl\\u00e9ber Mascarenhas\",\"name\":\"Dr. Kevin Cl\\u00e9ber Mascarenhas\",\"email\":\"beltrao.talita@matos.com\",\"phone\":\"(95) 92039-2234\",\"whatsapp\":\"(74) 99868-3791\",\"country_id\":537,\"country_name\":\"Brasil\",\"state_id\":416,\"state_name\":\"GO\",\"city_id\":953,\"city_name\":\"Senador Canedo\",\"address\":\"Largo Abreu, 85. 859\\u00ba Andar\",\"number\":\"8\",\"complement\":\"Apto 729\",\"neighborhood\":\"Nordeste\",\"postal_code\":\"73427-169\",\"all_customers_has_birdid\":null},\"customer\":{\"id\":8,\"ulid\":\"01hz7rpnnt9w8yaffzg9rmzkwm\",\"status\":true,\"registration_number\":\"58555228220\",\"name\":\"Dr. Cristiano de Arruda Quintana Jr.\",\"email\":\"qlourenco@example.org\",\"phone\":\"97950235969\",\"whatsapp\":\"32967501838\",\"bird_id\":{\"is_valid\":false,\"verified_at\":\"2024-05-31 13:46:06\"},\"videoconference\":{\"verification\":false,\"link\":\"http:\/\/tamoio.com\/et-et-ut-hic-deserunt-sint.html\"}},\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":null,\"amount\":\"2243.17\",\"details\":[{\"id\":9,\"product\":{\"id\":6,\"certificate_type\":\"A3\",\"person_type\":\"PF\",\"sku\":11,\"sisar_id\":4,\"name\":\"Certificado PF A3\",\"validate\":1,\"description\":\"Certificado PF A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"8.13\",\"additional_unit_value\":\"4.58\",\"final_unit_value\":\"12.71\",\"quantity\":1,\"amount\":\"12.71\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":10,\"product\":{\"id\":2,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":1,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"23.47\",\"additional_unit_value\":\"1.48\",\"final_unit_value\":\"24.95\",\"quantity\":18,\"amount\":\"449.10\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":11,\"product\":{\"id\":5,\"certificate_type\":\"A1\",\"person_type\":\"PF\",\"sku\":9,\"sisar_id\":3,\"name\":\"Certificado PF A1\",\"validate\":1,\"description\":\"Certificado PF A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"8.64\",\"additional_unit_value\":\"2.54\",\"final_unit_value\":\"11.18\",\"quantity\":16,\"amount\":\"178.88\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":12,\"product\":{\"id\":8,\"certificate_type\":\"A3\",\"person_type\":\"PF\",\"sku\":11,\"sisar_id\":4,\"name\":\"Certificado PF A3\",\"validate\":3,\"description\":\"Certificado PF A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"22.58\",\"additional_unit_value\":\"8.24\",\"final_unit_value\":\"30.82\",\"quantity\":9,\"amount\":\"277.38\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":13,\"product\":{\"id\":6,\"certificate_type\":\"A3\",\"person_type\":\"PF\",\"sku\":11,\"sisar_id\":4,\"name\":\"Certificado PF A3\",\"validate\":1,\"description\":\"Certificado PF A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a3\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"23.26\",\"additional_unit_value\":\"4.62\",\"final_unit_value\":\"27.88\",\"quantity\":15,\"amount\":\"418.20\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":14,\"product\":{\"id\":5,\"certificate_type\":\"A1\",\"person_type\":\"PF\",\"sku\":9,\"sisar_id\":3,\"name\":\"Certificado PF A1\",\"validate\":1,\"description\":\"Certificado PF A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pf-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"45.50\",\"additional_unit_value\":\"2.06\",\"final_unit_value\":\"47.56\",\"quantity\":11,\"amount\":\"523.16\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"},{\"id\":15,\"product\":{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-05-31T12:00:00.000000Z\",\"updated_at\":\"2024-05-31T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"47.30\",\"additional_unit_value\":\"7.52\",\"final_unit_value\":\"54.82\",\"quantity\":7,\"amount\":\"383.74\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-05-31T12:00:00.000000Z\"}]}],\"links\":{\"first\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=1\",\"last\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=2\",\"prev\":null,\"next\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"active\":false},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=1\",\"label\":\"1\",\"active\":true},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=2\",\"label\":\"2\",\"active\":false},{\"url\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders?page=2\",\"label\":\"Pr\\u00f3ximo »\",\"active\":false}],\"path\":\"https:\/\/api-contadores-hom.solutipro.com.br\/api\/v1\/organization\/01jx03sjcymkbtghxe7anjkj4v\/orders\",\"per_page\":1,\"to\":10,\"total\":2}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Total de Negocia\u00e7\u00f5es por Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders\/total-per-status", "query": [ { "key": "company", "value": "01jx03vsk2a58yw82g54cyvgzp", "description": "ULID da Empresa", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders\/total-per-status?company=01jx03vsk2a58yw82g54cyvgzp", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar Total de Negocia\u00e7\u00f5es por Status da Organiza\u00e7\u00e3o ou Empresa (Big Numbers)" }, "response": [ { "header": [], "code": 200, "body": "{\"new\":4,\"payment_pending\":1,\"payment_confirmed\":1,\"processing\":1,\"approved_certificate\":1,\"finished\":1,\"canceled\":1}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Cadastro de Negocia\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"purchase_order\",\"force_videoconference\":false,\"payment_modality_id\":1,\"company_id\":1,\"customer_id\":1,\"details\":[{\"product_id\":1,\"additional_unit_value\":\"2.50\",\"quantity\":1}]}" }, "description": "Endpoint para cadastrar uma Negocia\u00e7\u00e3o" }, "response": [ { "header": [], "code": 201, "body": "{\"order\":{\"id\":1,\"ulid\":\"01hz2hd34jx43p4ejkdjsksnmb\",\"type\":\"purchase_order\",\"public_token\":null,\"order_id\":null,\"order_code\":null,\"status\":{\"id\":1,\"code\":\"new\",\"label\":\"Novo\"},\"status_date\":\"2024-06-05T12:00:00.000000Z\",\"obs\":null,\"created_at\":\"2024-06-05T12:00:00.000000Z\",\"updated_at\":null,\"details\":[]}}", "name": "Created" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Mostrar uma Negocia\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders\/:order_ulid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders\/:order_ulid", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "order_ulid", "key": "order_ulid", "value": "01jx03vfwywqerx836r25qsycz", "description": "ULID da Negocia\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar uma Negocia\u00e7\u00e3o da Organiza\u00e7\u00e3o ou Empresa pelo ULID" }, "response": [ { "header": [], "code": 200, "body": "{\"order\":{\"id\":1,\"ulid\":\"01hz2hd34jx43p4ejkdjsksnmb\",\"type\":\"purchase_order\",\"public_token\":null,\"order_id\":null,\"order_code\":null,\"status\":{\"id\":1,\"code\":\"new\",\"label\":\"Novo\"},\"force_videoconference\":false,\"status_date\":\"2024-06-05T12:00:00.000000Z\",\"obs\":null,\"payment_modality\":{\"id\":1,\"name\":\"PAYMENT_ACCOUTING\",\"code\":\"INDIVIDUAL_SALE\",\"status\":true,\"created_at\":\"2024-06-04T12:00:00.000000Z\",\"updated_at\":\"2024-06-04T12:00:00.000000Z\"},\"payment_method\":null,\"price\":{\"id\":21,\"name\":\"Pre\\u00e7o Teste 1\",\"slug\":\"preco-teste-1\",\"status\":\"Rascunho\",\"start_date\":\"2024-06-04T12:00:00.000000Z\",\"end_date\":null,\"link\":\"LINK_DOWNLOAD_PLANILHA\"},\"production_range\":{\"id\":9,\"slug\":\"production-range-teste-1\",\"start\":1,\"end\":5,\"status\":true,\"description\":\"Production Range Teste 1\"},\"organization\":{\"id\":6,\"ulid\":\"01hzhtew5jqkr4m9bmhgpsby08\",\"status\":true,\"type\":\"J\",\"registration_number\":\"33333333333333\",\"alias\":\"Contabilidade A\",\"name\":\"Contabilidade A\",\"ulid_ar\":\"01hzhtew25310zqk92ec5rm2gb\",\"ar_subdomain\":\"arpartnerhom\",\"theme\":{\"primary\":null,\"secondary\":null,\"logo\":null},\"organization_type\":{\"id\":4,\"ulid\":\"01j0trb4j2n6mg4z97y9x2gkve\",\"status\":1,\"code\":\"accounting\",\"name\":\"Contabilidade\",\"created_at\":\"2024-06-20T12:00:00.000000Z\"},\"email\":\"contabilidade@soluti.com.br\",\"phone\":null,\"whatsapp\":null,\"country_id\":null,\"state_id\":null,\"city_id\":null,\"address\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"postal_code\":null},\"company\":{\"id\":2,\"ulid\":\"01hzhtf066f46650bpfv008bmv\",\"status\":true,\"type\":\"F\",\"registration_number\":\"30891275479\",\"alias\":\"Marta Mascarenhas Sobrinho\",\"name\":\"Marta Mascarenhas Sobrinho\",\"email\":\"constancia.gusmao@fernandes.com.br\",\"phone\":\"(19) 94025-8623\",\"whatsapp\":\"(67) 96389-5342\",\"country_id\":470,\"country_name\":\"Brasil\",\"state_id\":895,\"state_name\":\"GO\",\"city_id\":544,\"city_name\":\"Senador Canedo\",\"address\":\"Rua Rios, 4881\",\"number\":\"90\",\"complement\":\"Bloco C\",\"neighborhood\":\"Centro-Oeste\",\"postal_code\":\"87213-085\",\"all_customers_has_birdid\":null},\"customer\":{\"id\":5,\"ulid\":\"01hzhtf06c75dr8j1mhw2fhvse\",\"status\":true,\"registration_number\":\"06705751355\",\"name\":\"Dr. Wellington Dante Carrara Sobrinho\",\"email\":\"mariah15@example.net\",\"phone\":\"54958049906\",\"whatsapp\":\"18970822194\",\"bird_id\":{\"is_valid\":false,\"verified_at\":\"2024-06-04 11:29:16\"},\"videoconference\":{\"verification\":true,\"link\":\"https:\\\\\/\\\\\/salgado.com.br\\\\\/ut-voluptatem-laudantium-repudiandae-sit.html\"}},\"created_at\":\"2024-06-05T12:00:00.000000Z\",\"updated_at\":null,\"amount\":\"387.22\",\"details\":[{\"id\":50,\"product\":{\"id\":1,\"certificate_type\":\"A1\",\"person_type\":\"PJ\",\"sku\":10,\"sisar_id\":1,\"name\":\"Certificado PJ A1\",\"validate\":1,\"description\":\"Certificado PJ A1\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a1\",\"is_ssl\":false,\"created_at\":\"2024-06-04T12:00:00.000000Z\",\"updated_at\":\"2024-06-04T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"10.99\",\"additional_unit_value\":\"5.99\",\"final_unit_value\":\"16.98\",\"quantity\":5,\"amount\":\"84.90\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-06-05T12:00:00.000000Z\"},{\"id\":51,\"product\":{\"id\":2,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":1,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-06-04T12:00:00.000000Z\",\"updated_at\":\"2024-06-04T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"15.99\",\"additional_unit_value\":\"0.00\",\"final_unit_value\":\"15.99\",\"quantity\":10,\"amount\":\"159.90\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-06-05T12:00:00.000000Z\"},{\"id\":52,\"product\":{\"id\":3,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":2,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-06-04T12:00:00.000000Z\",\"updated_at\":\"2024-06-04T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"5.99\",\"additional_unit_value\":\"1.50\",\"final_unit_value\":\"7.49\",\"quantity\":8,\"amount\":\"59.92\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-06-05T12:00:00.000000Z\"},{\"id\":53,\"product\":{\"id\":4,\"certificate_type\":\"A3\",\"person_type\":\"PJ\",\"sku\":12,\"sisar_id\":2,\"name\":\"Certificado PJ A3\",\"validate\":3,\"description\":\"Certificado PJ A3\",\"min_price\":\"10.00\",\"max_price\":\"199.99\",\"status\":true,\"slug\":\"certificado-pj-a3\",\"is_ssl\":false,\"created_at\":\"2024-06-04T12:00:00.000000Z\",\"updated_at\":\"2024-06-04T12:00:00.000000Z\"},\"solicitation_sisar\":null,\"solicitation_link\":null,\"original_unit_value\":\"25.00\",\"additional_unit_value\":\"2.50\",\"final_unit_value\":\"27.50\",\"quantity\":3,\"amount\":\"82.50\",\"product_fields\":null,\"documentation_ok\":null,\"validated_domain\":null,\"created_at\":\"2024-06-05T12:00:00.000000Z\"}]}}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Cancelar Negocia\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders\/:order_ulid\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders\/:order_ulid\/cancel", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "order_ulid", "key": "order_ulid", "value": "01jx03pfbaxpd1wmjv0h9srxd4", "description": "ULID do Pedido" } ] }, "method": "DELETE", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para cancelar uma negocia\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"order\":{\"id\":582,\"ulid\":\"01jjptp21d4jzwadx861ar2gvc\",\"status\":{\"id\":7,\"code\":\"canceled\",\"label\":\"Cancelado\"},\"force_videoconference\":false,\"status_date\":\"2025-02-10T12:00:00.000000Z\",\"type\":\"sell_order\",\"created_at\":\"2025-01-28T12:00:00.000000Z\",\"updated_at\":null},\"message\":\"Negocia\\u00e7\\u00e3o cancelada com sucesso\"}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"Negocia\\u00e7\\u00e3o n\\u00e3o pode ser cancelada.\",\"errors\":{\"message\":[\"Negocia\\u00e7\\u00e3o n\\u00e3o pode ser cancelada.\"]}}", "name": "Unprocessable Content" } ] }, { "name": "Gerar Link de Checkout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders\/:order_ulid\/checkout-link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders\/:order_ulid\/checkout-link", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "order_ulid", "key": "order_ulid", "value": "01jx03pws3mbrnrnry9ry8pyqm", "description": "ULID do Pedido" } ] }, "method": "POST", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para gerar Checkout Link do Gest\u00e3o Online" }, "response": [ { "header": [], "code": 200, "body": "{\"checkout-link\":\"https:\/\/checkout-hom.soluti.com.br\/loja\/checkout?callBackResponseUrl=http:\/\/api.omeuportal.com.br:8000\/api\/v1\/webhook\/order&t=ONTc5_MTcxNzYxNjM2MzIyNDE_I6OpqvAg4P2D06_bcG4XYw\"}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" }, { "header": [], "code": 422, "body": "{\"message\":\"\",\"errors\":[]}", "name": "Unprocessable Content" } ] }, { "name": "Mostrar Link de Checkout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/orders\/:order_ulid\/checkout-link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/orders\/:order_ulid\/checkout-link", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "order_ulid", "key": "order_ulid", "value": "01jx03pws3mbrnrnry9ry8pyqm", "description": "ULID do Pedido" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar Checkout Link do Gest\u00e3o Online" }, "response": [ { "header": [], "code": 200, "body": "{\"checkout-link\":\"https:\/\/checkout-hom.soluti.com.br\/loja\/checkout?callBackResponseUrl=http:\/\/api.omeuportal.com.br:8000\/api\/v1\/webhook\/order&t=ONTc5_MTcxNzYxNjM2MzIyNDE_I6OpqvAg4P2D06_bcG4XYw\"}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Reserva", "description": "Recursos relacionados a Reserva da API", "item": [ { "name": "Total de Reserva por Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/stocks\/total-per-status", "query": [ { "key": "product_sku", "value": "10", "description": "SKU do Produto", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/stocks\/total-per-status?product_sku=10", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar Total de Reserva por Status" }, "response": [ { "header": [], "code": 200, "body": "{\"status\":{\"in_stock\":10,\"reserved\":20},\"total\":30}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Total de Reserva por Produto", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/stocks\/total-per-product", "query": [ { "key": "status", "value": "in_stock", "description": "Status da reserva", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/stocks\/total-per-product?status=in_stock", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar Total de Reserva por Produto" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"product\":{\"id\":2,\"name\":\"Certificado PJ A1 - Spro Contadores\",\"sku\":19776,\"product_id_sisar\":310},\"stock\":{\"status\":{\"id\":1,\"name\":\"in_stock\",\"label\":\"Em Estoque\"},\"total\":1395}},{\"product\":{\"id\":3,\"name\":\"PF A1\",\"sku\":10,\"product_id_sisar\":1},\"stock\":{\"status\":{\"id\":1,\"name\":\"in_stock\",\"label\":\"Em Estoque\"},\"total\":6}}]}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] } ] }, { "name": "Solicita\u00e7\u00e3o", "description": "Recursos relacionados a buscar de Solicita\u00e7\u00f5es da API", "item": [ { "name": "Total de Solicita\u00e7\u00f5es por Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/solicitations\/total-per-status", "query": [ { "key": "registration_number", "value": "81282527045", "description": "CPF\/CNPJ da Empresa", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/solicitations\/total-per-status?registration_number=81282527045", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para listar Total de Solicita\u00e7\u00f5es por Status da Organiza\u00e7\u00e3o (Big Numbers) por CPF\/CNPJ" }, "response": [ { "header": [], "code": 200, "body": "{\"pending\":41,\"active\":48,\"inactive\":125,\"expiring\":5}", "name": "OK" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthorized\"}", "name": "Unauthorized" }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden\"}", "name": "Forbidden" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "Not Found" } ] }, { "name": "Mostrar uma Solicita\u00e7\u00e3o", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:ulid\/solicitations\/:code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:ulid\/solicitations\/:code", "variable": [ { "id": "ulid", "key": "ulid", "value": "01jx051j8n539qp7swab85mvza", "description": "ULID da Organiza\u00e7\u00e3o" }, { "id": "code", "key": "code", "value": "1867240510736592", "description": "C\u00f3digo da Solicita\u00e7\u00e3o" } ] }, "method": "GET", "header": [ { "key": "x-spro-authorization", "value": "{AUTHORIZATION_ACCESS_TOKEN}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint para mostrar uma Solicita\u00e7\u00e3o da Organiza\u00e7\u00e3o por c\u00f3digo