openapi: 3.0.3 info: title: 'Soluti PRO - EVD' description: 'API Soluti PRO - EVD para integração entre Frontend, Sistema de ARs e Bird ID.' version: 1.0.0 servers: - url: 'https://api-contadores-evd.solutipro.com.br' tags: - name: API description: '' - name: V1 description: '' components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: [] paths: /api/health: get: summary: Check operationId: check description: 'Endpoint de Health Check' parameters: [] responses: 200: description: OK content: application/json: schema: type: object example: '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 properties: 0: type: object properties: label: type: string example: DB status: type: string example: ok 1: type: object properties: label: type: string example: Schedule status: type: string example: ok 2: type: object properties: label: type: string example: 'REDIS Cache' status: type: string example: ok 3: type: object properties: label: type: string example: Environment status: type: string example: ok 4: type: object properties: label: type: string example: RabbitMQ status: type: string example: ok 5: type: object properties: label: type: string example: 'Environment Variables Check' status: type: string example: ok 6: type: object properties: label: type: string example: Octane status: type: string example: ok 7: type: object properties: label: type: string example: 'Debug Mode' status: type: string example: ok date: type: integer example: 1720198684 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - API security: [] /api/v1/auth/logout: post: summary: Logout operationId: logout description: 'Invalidar o Token.' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: type: object example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 /api/v1/auth/refresh: post: summary: 'Refresh Token' operationId: refreshToken description: 'Gerar novo Token sem necessidade de uma nova autenticação.' parameters: [] responses: 200: description: OK content: application/json: schema: type: object example: access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: Bearer expires_in: 86400 properties: access_token: type: string example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: type: string example: Bearer expires_in: type: integer example: 86400 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 /api/v1/auth/login: post: summary: Login operationId: login description: 'Realizar Autenticação na API.' parameters: [] responses: 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: registration_number: type: string description: 'CPF/CNPJ de Autenticação' example: '12345678919' password: type: string description: 'Código OTP/Chave API de Autenticação' example: - '123456' - 9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be required: - registration_number - password security: [] /api/v1/auth/birdid: post: summary: Autenticação operationId: autenticao description: 'Realizar Autenticação na API.' parameters: [] responses: 200: description: OK content: application/json: schema: type: object example: access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: Bearer expires_in: 86400 properties: access_token: type: string example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: type: string example: Bearer expires_in: type: integer example: 86400 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: registration_number: type: string description: 'CPF/CNPJ de Autenticação' example: '12345678919' password: type: string description: 'Código OTP/Chave API de Autenticação' example: - '123456' - 9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be required: - registration_number - password security: [] /api/v1/auth/authorization: post: summary: Autorização operationId: autorizao description: 'Realizar Autorização na API.' parameters: [] responses: 200: description: OK content: application/json: schema: type: object example: access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: Bearer expires_in: 86400 properties: access_token: type: string example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0 token_type: type: string example: Bearer expires_in: type: integer example: 86400 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 '/api/v1/organization/{ulid}': get: summary: 'Visualizar uma Organização' operationId: visualizarUmaOrganizao description: 'Endpoint para mostrar uma Organização' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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: [] properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ulid_ar: type: string example: 01j5r7hmaar4gd1pssg0mv0erv ar_subdomain: type: string example: uchoa.net.br email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 production_range: type: string example: null price: type: string example: null products: type: array example: [] payment_modalities: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 put: summary: 'Atualizar a Organização logada' operationId: atualizarAOrganizaoLogada description: 'Endpoint para atualizar a Organização logada' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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: [] properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ulid_ar: type: string example: 01j5r7hmaar4gd1pssg0mv0erv ar_subdomain: type: string example: uchoa.net.br email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 production_range: type: string example: null price: type: string example: null products: type: array example: [] payment_modalities: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: status: type: boolean description: 'Status da Organização' example: true nullable: true alias: type: string description: 'Alias da Organização' example: 'Aguiar e Associados' nullable: true name: type: string description: 'Nome da Organização' example: 'Aguiar e Associados' nullable: true phone: type: string description: 'Telefone/Celular da Organização' example: '(97) 97317-3799' nullable: true whatsapp: type: string description: 'Whatsapp da Organização' example: '(75) 94533-8056' nullable: true email: type: string description: 'E-mail da Organização' example: julia.alcantara@burgos.br nullable: true country_id: type: integer description: 'ID do País da Organização' example: '181' nullable: true country_name: type: string description: 'Nome do País da Organização' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Organização' example: '719' nullable: true state_name: type: string description: 'UF do Estado da Organização' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'Código IBGE da Cidade da Organização' example: '281' nullable: true city_name: type: string description: 'Nome da Cidade da Organização' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Organização' example: Norte nullable: true postal_code: type: string description: 'CEP da Organização' example: 70033-161 nullable: true address: type: string description: Endereço example: 'Av. Carlos, 609. Bloco A' nullable: true number: type: string description: Número example: '784' nullable: true complement: type: string description: Complemento example: 'Apto 5' nullable: true price_id: type: integer description: 'ID do Preço da Organização' example: '1' nullable: true production_range_id: type: integer description: 'ID da Faixa de Produção da Organização' example: '1' nullable: true products_skus: type: object description: 'The sku of an existing record in the products table.' example: null properties: { } nullable: true payment_modalities_code: type: object description: 'The code of an existing record in the payment_modalities table.' example: null properties: { } nullable: true required: - alias - name - email parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/organizations': get: summary: 'Listagem de Organizações filhas' operationId: listagemDeOrganizaesFilhas description: 'Endpoint para listar as Organizações filhas' parameters: - in: query name: with_oldest_user description: '' example: null required: false schema: type: string description: '' example: null - in: query name: with_users description: '' example: null required: false schema: type: string description: '' example: null - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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: [] properties: data: type: array example: - 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: [] items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hskavrd19b97zf0b0wza6mxg status: type: boolean example: true type: type: string example: J registration_number: type: string example: '23941629000131' alias: type: string example: 'Faria e Campos e Filhos' name: type: string example: 'Faria e Campos e Filhos' ulid_ar: type: string example: 01j5r7hmaar4gd1pssg0mv0erv ar_subdomain: type: string example: vieira.com email: type: string example: olivia.urias@fernandes.net phone: type: string example: '(87) 94504-7332' whatsapp: type: string example: '(69) 95915-7641' country_id: type: integer example: 355 state_id: type: integer example: 256 city_id: type: integer example: 487 address: type: string example: 'Travessa Gilberto, 12. Apto 43' number: type: string example: '108' complement: type: string example: 'Bc. 54 Ap. 33' neighborhood: type: string example: Sul postal_code: type: string example: 43903-374 oldest_user: type: string example: null users: type: array example: [] production_range: type: string example: null price: type: string example: null products: type: array example: [] payment_modalities: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 post: summary: 'Cadastro de Organização' operationId: cadastroDeOrganizao description: 'Endpoint para cadastrar uma Organização FILHA' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: 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 properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ar_subdomain: type: string example: uchoa.net.br email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 production_range: type: string example: null price: type: string example: null products: type: string example: null payment_modalities: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: 'Tipo da Organização' example: J enum: - F - J registration_number: type: string description: 'CPF/CNPJ da Organização' example: '19640726000117' alias: type: string description: 'Alias da Organização' example: 'Aguiar e Associados' name: type: string description: 'Nome da Organização' example: 'Aguiar e Associados' phone: type: string description: 'Telefone/Celular da Organização' example: '(97) 97317-3799' nullable: true whatsapp: type: string description: 'Whatsapp da Organização' example: '(75) 94533-8056' nullable: true email: type: string description: 'E-mail da Organização' example: julia.alcantara@burgos.br nullable: true ar_subdomain: type: string description: 'Subdomínio da AR da Organização' example: arsoluti nullable: true country_id: type: integer description: 'ID do País da Organização' example: '181' nullable: true country_name: type: string description: 'Nome do País da Organização' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Organização' example: '719' nullable: true state_name: type: string description: 'UF do Estado da Organização' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'Código IBGE da Cidade da Organização' example: '281' nullable: true city_name: type: string description: 'Nome da Cidade da Organização' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Organização' example: Norte nullable: true postal_code: type: string description: 'CEP da Organização' example: 70033-161 nullable: true address: type: string description: Endereço example: 'Av. Carlos, 609. Bloco A' nullable: true number: type: string description: Número example: '784' nullable: true complement: type: string description: Complemento example: 'Apto 5' nullable: true price_id: type: integer description: 'ID do Preço da Organização (Obrigatório para Vendedor e Contabilidade)' example: '1' organization_type_code: type: string description: 'Perfil da Organização' example: accounting products_skus: type: array description: 'SKUs dos produtos que serão vinculados a Organização' example: - 10 - 11 - 12 items: type: integer nullable: true payment_modalities_code: type: array description: 'Modalidades de pagamentos que serão vinculadas a Organização' example: - PAYMENT_ACCOUNTING - PAYMENT_CUSTOMER - DEBIT_STOCK - PRE_PAID_VOUCHER - POST_PAID_VOUCHER items: type: string nullable: true recaptcha-token: type: string description: '' example: null users: type: array description: 'Usuários que serão cadastrados a Organização' example: '' items: type: object nullable: true properties: name: type: string description: 'Nome do Usuário' example: 'Fulano de Tal' email: type: string description: 'E-mail do Usuário' example: usuario@teste.com.br registration_number: type: string description: 'CPF do Usuário' example: '11122233344' phone: type: string description: 'Telefone/Celular do Usuário' example: (11)99999-9999 nullable: true whatsapp: type: string description: 'Whatsapp do Usuário' example: (11)99999-9999 nullable: true required: - name - email - registration_number required: - type - registration_number - alias - name - email - organization_type_code parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/organizations/{child_ulid}': get: summary: 'Visualizar uma Organização filha' operationId: visualizarUmaOrganizaoFilha description: 'Endpoint para mostrar uma Organização FILHA' parameters: - in: query name: with_oldest_user description: '' example: null required: false schema: type: string description: '' example: null - in: query name: with_users description: '' example: null required: false schema: type: string description: '' example: null - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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: [] properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ulid_ar: type: string example: 01j5r7hmaar4gd1pssg0mv0erv ar_subdomain: type: string example: uchoa.net.br email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 oldest_user: type: string example: null users: type: array example: [] production_range: type: string example: null price: type: string example: null products: type: array example: [] payment_modalities: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 put: summary: 'Atualizar uma Organização filha' operationId: atualizarUmaOrganizaoFilha description: 'Endpoint para atualizar uma Organização FILHA' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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: [] properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ulid_ar: type: string example: 01j5r7hmaar4gd1pssg0mv0erv ar_subdomain: type: string example: uchoa.net.br organization_type: type: object properties: ulid: type: string example: 01j5r7hm75eh4mpvnhytzt8p2h status: type: integer example: 1 code: type: string example: accounting name: type: string example: Contabilidade created_at: type: string example: '2024-08-20T12:00:00.000000Z' email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 production_range: type: string example: null price: type: string example: null products: type: array example: [] payment_modalities: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: status: type: boolean description: 'Status da Organização' example: true nullable: true alias: type: string description: 'Alias da Organização' example: 'Aguiar e Associados' nullable: true name: type: string description: 'Nome da Organização' example: 'Aguiar e Associados' nullable: true phone: type: string description: 'Telefone/Celular da Organização' example: '(97) 97317-3799' nullable: true whatsapp: type: string description: 'Whatsapp da Organização' example: '(75) 94533-8056' nullable: true email: type: string description: 'E-mail da Organização' example: julia.alcantara@burgos.br nullable: true country_id: type: integer description: 'ID do País da Organização' example: '181' nullable: true country_name: type: string description: 'Nome do País da Organização' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Organização' example: '719' nullable: true state_name: type: string description: 'UF do Estado da Organização' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'Código IBGE da Cidade da Organização' example: '281' nullable: true city_name: type: string description: 'Nome da Cidade da Organização' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Organização' example: Norte nullable: true postal_code: type: string description: 'CEP da Organização' example: 70033-161 nullable: true address: type: string description: Endereço example: 'Av. Carlos, 609. Bloco A' nullable: true number: type: string description: Número example: '784' nullable: true complement: type: string description: Complemento example: 'Apto 5' nullable: true price_id: type: integer description: 'ID do Preço da Organização' example: '1' nullable: true production_range_id: type: integer description: 'ID da Faixa de Produção da Organização' example: '1' nullable: true products_skus: type: object description: 'The sku of an existing record in the products table.' example: null properties: { } nullable: true payment_modalities_code: type: object description: 'The code of an existing record in the payment_modalities table.' example: null properties: { } nullable: true users: type: array description: 'Usuários que serão atualizados na Organização' example: '' items: type: object nullable: true properties: name: type: string description: 'Nome do Usuário' example: 'Fulano de Tal' nullable: true email: type: string description: 'E-mail do Usuário' example: usuario@teste.com.br nullable: true registration_number: type: string description: 'CPF do Usuário' example: '11122233344' phone: type: string description: 'Telefone/Celular do Usuário' example: (11)99999-9999 nullable: true whatsapp: type: string description: 'Whatsapp do Usuário' example: (11)99999-9999 nullable: true deleted: type: boolean description: 'Flag para definir se o Usuário será removido da Organização' example: null required: - name - email - registration_number required: - alias - name - email parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: child_ulid description: 'ULID da Organização FILHA' example: 01jx04hzemzdpx07k34bhers9b required: true schema: type: string '/api/v1/organization/{ulid}/users/logged': put: summary: 'Alterar usuário logado' operationId: alterarUsurioLogado description: 'Endpoint para alterar o usuário logado' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: user: type: object properties: ulid: type: string example: 01hskccmp33ztvmgf2aa4wcb2k name: type: string example: 'Dr. Vicente Velasques Sandoval' email: type: string example: lourenco.kleber@example.net registration_number: type: string example: '37194478200' phone: type: string example: (62)99999-9999 whatsapp: type: string example: (62)99999-9999 bird_id: type: object properties: is_valid: type: boolean example: true verified_at: type: string example: '2025-06-25 16:39:42' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: 'https://roque.com/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil' created_at: type: string example: '2024-03-22T12:00:00.000000Z' updated_at: type: string example: '2024-03-22T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Nome do Usuário' example: 'Fulano de Tal' email: type: string description: 'E-mail do Usuário' example: email@email.com phone: type: string description: 'Telefone/Celular do Usuário' example: (11)99999-9999 required: - name get: summary: 'Buscar dados do usuário logado' operationId: buscarDadosDoUsurioLogado description: 'Endpoint para buscar dados do usuário logado' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: user: type: object properties: ulid: type: string example: 01hskccmp33ztvmgf2aa4wcb2k name: type: string example: 'Dr. Vicente Velasques Sandoval' email: type: string example: lourenco.kleber@example.net registration_number: type: string example: '37194478200' phone: type: string example: (62)99999-9999 whatsapp: type: string example: (62)99999-9999 bird_id: type: object properties: is_valid: type: boolean example: true verified_at: type: string example: '2025-06-25 16:39:42' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: 'https://roque.com/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil' created_at: type: string example: '2024-03-22T12:00:00.000000Z' updated_at: type: string example: '2024-03-22T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/users/{registration_number}': get: summary: 'Buscar usuário por CPF' operationId: buscarUsurioPorCPF description: 'Endpoint para buscar um usuário por CPF' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: user: type: object properties: ulid: type: string example: 01hskccmp33ztvmgf2aa4wcb2k name: type: string example: 'Dr. Vicente Velasques Sandoval' email: type: string example: lourenco.kleber@example.net registration_number: type: string example: '37194478200' phone: type: string example: (62)99999-9999 whatsapp: type: string example: (62)99999-9999 bird_id: type: object properties: is_valid: type: boolean example: true verified_at: type: string example: '2025-06-25 16:39:42' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: 'https://roque.com/natus-odit-cupiditate-aliquam-maiores-nostrum-eius-officia-nihil' created_at: type: string example: '2024-03-22T12:00:00.000000Z' updated_at: type: string example: '2024-03-22T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: registration_number description: 'CPF do Usuário' example: '37194478200' required: true schema: type: string '/api/v1/organization/{ulid}/companies': get: summary: 'Listagem de Empresas' operationId: listagemDeEmpresas description: 'Endpoint para mostrar todos, ou por filtro, os clientes da Organização' parameters: - in: query name: filter description: 'Filtro do autocomplete, CPF/CNPJ ou Nome' example: null required: false schema: type: string description: 'Filtro do autocomplete, CPF/CNPJ ou Nome' example: null - in: query name: order description: 'Tipos de Ordenação. consiste em um array, contendo coluna e direção.' example: column: name direction: asc required: false schema: type: object description: 'Tipos de Ordenação. consiste em um array, contendo coluna e direção.' example: column: name direction: asc properties: { } - in: query name: order.column description: '' example: quia required: false schema: type: string description: '' example: quia enum: - name - alias - in: query name: order.direction description: '' example: consequatur required: false schema: type: string description: '' example: consequatur enum: - asc - desc - in: query name: status description: 'Filtrar empresas ativas/inativas' example: facilis required: false schema: type: string description: 'Filtrar empresas ativas/inativas' example: facilis enum: - all - active - inactive - in: query name: customers description: 'Retorna os representantes legais da Empresa' example: ut required: false schema: type: string description: 'Retorna os representantes legais da Empresa' example: ut enum: - all - with_bird_id - without_bird_id - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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ânia address: 'Travessa Ramos, 33' number: '60000' complement: '7º 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ânia address: 'Rua Toledo, 5350. F' number: '2' complement: '2º Andar' neighborhood: Norte postal_code: 73813-996 all_customers_has_birdid: false links: first: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=1' last: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' prev: null next: 'https://api-contadores-evd.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-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' label: 'Próximo »' active: false path: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies' per_page: 1 to: 10 total: 2 properties: data: type: array example: - 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ânia address: 'Travessa Ramos, 33' number: '60000' complement: '7º 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ânia address: 'Rua Toledo, 5350. F' number: '2' complement: '2º Andar' neighborhood: Norte postal_code: 73813-996 all_customers_has_birdid: false items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsk870t6gvtst3jnckpn6wwk status: type: boolean example: true type: type: string example: J registration_number: type: string example: '44252837000101' alias: type: string example: 'Rezende Comercial Ltda.' name: type: string example: 'Rezende Comercial Ltda.' email: type: string example: epaz@balestero.br phone: type: string example: '(48) 98832-7335' whatsapp: type: string example: '(18) 92050-9242' country_id: type: integer example: 846 country_name: type: string example: Brasil state_id: type: integer example: 397 state_name: type: string example: GO city_id: type: integer example: 196 city_name: type: string example: Goiânia address: type: string example: 'Travessa Ramos, 33' number: type: string example: '60000' complement: type: string example: '7º Andar' neighborhood: type: string example: Sudeste postal_code: type: string example: 93870-423 all_customers_has_birdid: type: boolean example: true links: type: object properties: first: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=1' last: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' prev: type: string example: null next: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 2 links: type: array example: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies?page=2' label: 'Próximo »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Anterior' active: type: boolean example: false path: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03k23s2qx6qs7y7s20c6t5/companies' per_page: type: integer example: 1 to: type: integer example: 10 total: type: integer example: 2 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 post: summary: 'Cadastro de Empresa' operationId: cadastroDeEmpresa description: 'Endpoint para cadastrar uma Empresa vinculada a uma Organização' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: 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 properties: company: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsk7nf8s05cgr9ewyx6xj39c status: type: boolean example: true type: type: string example: J registration_number: type: string example: '58312998000140' alias: type: string example: 'Barreto e Rodrigues e Filhos' name: type: string example: 'Barreto e Rodrigues e Filhos' email: type: string example: murilo63@abreu.com phone: type: string example: '(87) 90410-2583' whatsapp: type: string example: '(22) 98676-2512' country_id: type: integer example: 846 state_id: type: integer example: 397 city_id: type: integer example: 196 address: type: string example: 'Largo Renan, 2. Bloco C' number: type: string example: '68111' complement: type: string example: 'Bc. 8 Ap. 47' neighborhood: type: string example: Sul postal_code: type: string example: 95765-846 customers: type: array example: - 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 items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsf065qevt1176yz3cgtk118 status: type: boolean example: true registration_number: type: string example: '81282527045' name: type: string example: 'Fulano de Tal' email: type: string example: fulano@gmail.com phone: type: string example: (62)98178-0000 whatsapp: type: string example: (62)98178-0000 bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-04-23 15:09:50' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: 'Tipo da Empresa' example: J enum: - F - J registration_number: type: string description: 'CPF/CNPJ da Empresa' example: '58312998000140' alias: type: string description: 'Alias da Empresa' example: 'Barreto e Rodrigues e Filhos' name: type: string description: 'Nome da Empresa' example: 'Barreto e Rodrigues e Filhos' phone: type: string description: 'Telefone/Celular da Empresa' example: '(87) 90410-2583' nullable: true whatsapp: type: string description: 'Whatsapp da Empresa' example: '(22) 98676-2512' nullable: true email: type: string description: 'E-mail da Empresa' example: murilo63@abreu.com nullable: true country_id: type: integer description: 'ID do País da Empresa' example: '846' nullable: true country_name: type: string description: 'Nome do País da Empresa' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Empresa' example: '397' nullable: true state_name: type: string description: 'UF do Estado da Empresa' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'ID da Cidade da Empresa' example: '196' nullable: true city_name: type: string description: 'Nome da Cidade da Empresa' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Empresa' example: Sul nullable: true postal_code: type: string description: 'CEP da Empresa' example: 95765-846 nullable: true address: type: string description: Endereço example: 'Largo Renan, 2. Bloco C' nullable: true number: type: string description: Número example: '68111' nullable: true complement: type: string description: Complemento example: 'Bc. 8 Ap. 47' nullable: true customer: type: object description: 'Cliente que será cadastrado a Empresa' example: name: 'Fulano de Tal' email: fulano@email.com registration_number: '81282527045' phone: (62)98178-0000 properties: name: type: string description: 'Nome do Cliente' example: 'Fulano de Tal' email: type: string description: 'E-mail do Cliente' example: usuario@teste.com.br registration_number: type: string description: 'CPF do Cliente' example: '11122233344' phone: type: string description: 'Telefone/Celular do Cliente' example: (11)99999-9999 nullable: true whatsapp: type: string description: 'Whatsapp do Cliente' example: (11)99999-9999 nullable: true required: - name - email - registration_number required: - type - registration_number - alias - name - email - customer parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/companies/{company_ulid}': get: summary: 'Visualizar uma Empresa' operationId: visualizarUmaEmpresa description: 'Endpoint para visualizar uma Empresa vinculada a uma Organização' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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ânia 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 properties: company: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsk7nf8s05cgr9ewyx6xj39c status: type: boolean example: true type: type: string example: J registration_number: type: string example: '58312998000140' alias: type: string example: 'Barreto e Rodrigues e Filhos' name: type: string example: 'Barreto e Rodrigues e Filhos' email: type: string example: murilo63@abreu.com phone: type: string example: '(87) 90410-2583' whatsapp: type: string example: '(22) 98676-2512' country_id: type: integer example: 846 country_name: type: string example: Brasil state_id: type: integer example: 397 state_name: type: string example: GO city_id: type: integer example: 196 city_name: type: string example: Goiânia address: type: string example: 'Largo Renan, 2. Bloco C' number: type: string example: '68111' complement: type: string example: 'Bc. 8 Ap. 47' neighborhood: type: string example: Sul postal_code: type: string example: 95765-846 customers: type: array example: - 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 items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsf065qevt1176yz3cgtk118 status: type: boolean example: true registration_number: type: string example: '81282527045' name: type: string example: 'Fulano de Tal' email: type: string example: fulano@gmail.com phone: type: string example: (62)98178-0000 whatsapp: type: string example: (62)98178-0000 bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-04-23 15:09:50' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 put: summary: 'Atualização de Empresas' operationId: atualizaoDeEmpresas description: 'Endpoint para atualizar uma Empresa vinculada a uma Organização' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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 properties: company: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hsk7nf8s05cgr9ewyx6xj39c status: type: boolean example: true type: type: string example: J registration_number: type: string example: '58312998000140' alias: type: string example: 'Barreto e Rodrigues e Filhos' name: type: string example: 'Barreto e Rodrigues e Filhos' email: type: string example: murilo63@abreu.com phone: type: string example: '(87) 90410-2583' whatsapp: type: string example: '(22) 98676-2512' country_id: type: integer example: 846 state_id: type: integer example: 397 city_id: type: integer example: 196 address: type: string example: 'Largo Renan, 2. Bloco C' number: type: string example: '68111' complement: type: string example: 'Bc. 8 Ap. 47' neighborhood: type: string example: Sul postal_code: type: string example: 95765-846 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: status: type: boolean description: '' example: false nullable: true alias: type: string description: 'Alias da Empresa' example: 'Barreto e Rodrigues e Filhos' nullable: true name: type: string description: 'Nome da Empresa' example: 'Barreto e Rodrigues e Filhos' nullable: true phone: type: string description: 'Telefone/Celular da Empresa' example: '(87) 90410-2583' nullable: true whatsapp: type: string description: 'Whatsapp da Empresa' example: '(22) 98676-2512' nullable: true email: type: string description: 'E-mail da Empresa' example: murilo63@abreu.com nullable: true country_id: type: integer description: 'ID do País da Empresa' example: '846' nullable: true country_name: type: string description: 'Nome do País da Empresa' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Empresa' example: '397' nullable: true state_name: type: string description: 'UF do Estado da Empresa' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'ID da Cidade da Empresa' example: '196' nullable: true city_name: type: string description: 'Nome da Cidade da Empresa' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Empresa' example: Sul nullable: true postal_code: type: string description: 'CEP da Empresa' example: 95765-846 nullable: true address: type: string description: Endereço example: 'Largo Renan, 2. Bloco C' nullable: true number: type: string description: Número example: '68111' nullable: true complement: type: string description: Complemento example: 'Bc. 8 Ap. 47' nullable: true customers: type: array description: 'Clientes que serão atualizados na Empresa' example: - 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 items: type: object nullable: true properties: name: type: string description: 'Nome do Cliente' example: 'Fulano de Tal' nullable: true email: type: string description: 'E-mail do Cliente' example: usuario@teste.com.br nullable: true registration_number: type: string description: 'CPF do Cliente' example: '11122233344' phone: type: string description: 'Telefone/Celular do Cliente' example: (11)99999-9999 nullable: true whatsapp: type: string description: 'Whatsapp do Cliente' example: (11)99999-9999 nullable: true status: type: boolean description: 'Desativar cliente' example: null nullable: true required: - name - email - registration_number required: - alias - name - email delete: summary: 'Desativar Empresa' operationId: desativarEmpresa description: 'Endpoint para desativar a Empresa de uma Organização' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 204: description: 'No Content' content: application/json: schema: type: array items: type: object example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: company_ulid description: 'ULID da Empresa' example: 01jx03kv1m7fccbs5brakp82rq required: true schema: type: string '/api/v1/organization/{ulid}/customers/{registration_number}/validate-birdid': get: summary: 'Validar Bird Id Cliente' operationId: validarBirdIdCliente description: 'Endpoint para validar Bird ID do Cliente.' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: bird_id: is_valid: true properties: bird_id: type: object properties: is_valid: type: boolean example: true 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx03nn8zg7pyg28408sk73am required: true schema: type: string - in: path name: registration_number description: 'CPF do Usuário' example: '37194478200' required: true schema: type: string '/api/v1/organization/{ulid}/customers/{customer_ulid}/send-video-conference-link': post: summary: 'Enviar e-mail de Videoconferência' operationId: enviarEMailDeVideoconferncia description: 'Endpoint para enviar e-mail com link de Videoconferência para o Cliente.' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: type: object example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx03n1dy9b7eqq4xs8h8zj87 required: true schema: type: string - in: path name: customer_ulid description: 'ULID do Cliente' example: 01jx03nadphsr85f8kh70tehac required: true schema: type: string '/api/v1/organization/{ulid}/production-ranges': post: summary: 'Cadastro de Faixa de Produção' operationId: cadastroDeFaixaDeProduo description: 'Endpoint para cadastrar uma faixa de produção (Organização do tipo AR)' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: production_range: id: 1 slug: 1-ate-100 start: 1 end: 100 status: true description: '1 até 100' properties: production_range: type: object properties: id: type: integer example: 1 slug: type: string example: 1-ate-100 start: type: integer example: 1 end: type: integer example: 100 status: type: boolean example: true description: type: string example: '1 até 100' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: 'Descrição da faixa de produção' example: '1 até 100' start: type: integer description: 'Faixa de produção inicial' example: 1 end: type: integer description: 'Faixa de produção final' example: 100 status: type: boolean description: 'Status da faixa de produção' example: true required: - description - start - end get: summary: 'Lista Faixa de Produção' operationId: listaFaixaDeProduo description: 'Endpoint para listar as faixas de produções associada a uma AR' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: data: - id: 1 slug: 1-ate-100 start: 1 end: 100 status: true description: '1 até 100' - id: 2 slug: 101-ate-300 start: 101 end: 300 status: true description: '101 até 300' - id: 3 slug: 301-ate-500 start: 301 end: 500 status: true description: '301 até 500' properties: data: type: array example: - id: 1 slug: 1-ate-100 start: 1 end: 100 status: true description: '1 até 100' - id: 2 slug: 101-ate-300 start: 101 end: 300 status: true description: '101 até 300' - id: 3 slug: 301-ate-500 start: 301 end: 500 status: true description: '301 até 500' items: type: object properties: id: type: integer example: 1 slug: type: string example: 1-ate-100 start: type: integer example: 1 end: type: integer example: 100 status: type: boolean example: true description: type: string example: '1 até 100' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/production-ranges/{production_range_id}': put: summary: 'Atualizar Faixa de Produção' operationId: atualizarFaixaDeProduo description: 'Endpoint para cadastrar uma faixa de produção (Organização do tipo AR)' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: production_range: id: 1 slug: 1-ate-100 start: 1 end: 100 status: true description: '1 até 100' properties: production_range: type: object properties: id: type: integer example: 1 slug: type: string example: 1-ate-100 start: type: integer example: 1 end: type: integer example: 100 status: type: boolean example: true description: type: string example: '1 até 100' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: description: type: string description: 'Descrição da faixa de produção' example: '1 até 100' status: type: boolean description: 'Status da faixa de produção' example: true start: type: integer description: 'Faixa de produção inicial' example: 1 end: type: integer description: 'Faixa de produção final' example: 100 required: - description - start - end parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: production_range_id description: 'ID da Faixa de Produção' example: 1 required: true schema: type: integer '/api/v1/organization/{ulid}/prices': post: summary: 'Cadastro de Preços' operationId: cadastroDePreos description: 'Endpoint para cadastrar um preço com seus detalhes' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: price: id: 1 name: 'Preço Teste' slug: preco-teste status: Rascunho start_date: '2025-06-05T12:00:00.000000Z' end_date: null link: LINK_DOWNLOAD_PLANILHA properties: price: type: object properties: id: type: integer example: 1 name: type: string example: 'Preço Teste' slug: type: string example: preco-teste status: type: string example: Rascunho start_date: type: string example: '2025-06-05T12:00:00.000000Z' end_date: type: string example: null link: type: string example: LINK_DOWNLOAD_PLANILHA 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Nome do Preço' example: 'Preço Teste' details: type: array description: 'Detalhes do preço que serão cadastrados' example: - 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 items: type: object properties: pre_cost: type: string description: 'Preço de Custo sugerido' example: '10.99' pre_sale: type: string description: 'Preço de Venda sugerido' example: '15.99' post_cost: type: string description: 'Preço de Custo' example: '12.99' post_sale: type: string description: 'Preço de Venda' example: '17.99' product_id: type: integer description: 'ID do Produto' example: 1 production_range_id: type: integer description: 'ID da Faixa de Produção' example: 1 required: - pre_cost - pre_sale - post_cost - post_sale - product_id - production_range_id required: - name - details parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/prices/calculate': post: summary: 'Calcular Preços dos Produtos' operationId: calcularPreosDosProdutos description: 'Endpoint para calcular os preços dos produtos informados através do quantidade relacionada a faixa de produção' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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 properties: production_range: type: object properties: id: type: integer example: 2 slug: type: string example: 11-a-20 start: type: integer example: 11 end: type: integer example: 20 status: type: boolean example: true description: type: string example: '11 a 20' products: type: array example: - 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' items: type: object properties: id: type: integer example: 1 quantity: type: integer example: 21 name: type: string example: 'Certificado PJ A1 - Spro Contadores' validate: type: integer example: 1 status: type: boolean example: true price: type: object properties: value_unit_origin: type: string example: '119.90' value_unit_current: type: string example: '109.90' amount_origin: type: string example: '2517.90' amount_current: type: string example: '2307.90' totals: type: object properties: total_origin: type: string example: '2517.90' total_current: type: string example: '2307.90' discounts: type: string example: '210.00' details: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: products: type: array description: 'Produtos para calcular o preço' example: - product_id: 1 quantity: 21 items: type: object properties: product_id: type: integer description: 'ID do Produto' example: 1 quantity: type: integer description: 'Quantidade de Produtos' example: 1 required: - product_id - quantity required: - products parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/payment-modalities': get: summary: 'Lista Modalidades de Pagamento' operationId: listaModalidadesDePagamento description: 'Endpoint para listar todos os modalidades de pagamentos' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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ção 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é-pago' code: PRE_PAID_VOUCHER status: true negotiations: - label: 'Contrato Pré Pago 2' negotiation: '987654321' order: 1 - label: 'Contrato Pré Pago 1' negotiation: '123456789' order: 2 main_negotiation: label: 'Contrato Pré 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ós-pago' code: POST_PAID_VOUCHER status: true negotiations: - label: 'Contrato Pós Pago 1' negotiation: 1234XPTO order: 1 - label: 'Contrato Pós Pago 2' negotiation: XPTO1234 order: 2 main_negotiation: label: 'Contrato Pós Pago 1' negotiation: 1234XPTO order: 1 created_at: '2024-06-28T12:00:00.000000Z' updated_at: '2024-07-01T12:00:00.000000Z' properties: data: type: array example: - 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ção 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é-pago' code: PRE_PAID_VOUCHER status: true negotiations: - label: 'Contrato Pré Pago 2' negotiation: '987654321' order: 1 - label: 'Contrato Pré Pago 1' negotiation: '123456789' order: 2 main_negotiation: label: 'Contrato Pré 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ós-pago' code: POST_PAID_VOUCHER status: true negotiations: - label: 'Contrato Pós Pago 1' negotiation: 1234XPTO order: 1 - label: 'Contrato Pós Pago 2' negotiation: XPTO1234 order: 2 main_negotiation: label: 'Contrato Pós Pago 1' negotiation: 1234XPTO order: 1 created_at: '2024-06-28T12:00:00.000000Z' updated_at: '2024-07-01T12:00:00.000000Z' items: type: object properties: id: type: integer example: 1 name: type: string example: 'Pagamento feito pela contabilidade' code: type: string example: PAYMENT_ACCOUNTING status: type: boolean example: true negotiations: type: array example: [] main_negotiation: type: array example: [] created_at: type: string example: '2024-06-28T12:00:00.000000Z' updated_at: type: string example: '2024-06-28T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/payment-modalities/negotiation/check-balance': get: summary: 'Verificar Saldo (Negociação SDeal)' operationId: verificarSaldoNegociaoSDeal description: 'Endpoint para verificar o saldo da negociação SDeal para modalidade de pagamento' parameters: - in: query name: registration_number description: 'CNPJ da Organização' example: '56539899000170' required: true schema: type: string description: 'CNPJ da Organização' example: '56539899000170' - in: query name: negotiation description: 'Negociação SDeal' example: '160222' required: true schema: type: string description: 'Negociação SDeal' example: '160222' - in: query name: type description: 'Modelo da Negociação SDeal' example: PRE required: true schema: type: string description: 'Modelo da Negociação SDeal' example: PRE enum: - PRE - POS - in: query name: sku description: 'SKU do Produto' example: 10 required: true schema: type: string description: 'SKU do Produto' example: 10 - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: balance: 10 properties: balance: type: integer example: 10 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/payment-methods': get: summary: 'Lista métodos de pagamento' operationId: listaMtodosDePagamento description: 'Endpoint para listar todos os métodos de pagamentos' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: data: - id: 1 name: 'Cartão de Crédito' 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ário' 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' properties: data: type: array example: - id: 1 name: 'Cartão de Crédito' 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ário' 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' items: type: object properties: id: type: integer example: 1 name: type: string example: 'Cartão de Crédito' code: type: string example: CREDIT_CARD status: type: boolean example: true created_at: type: string example: '2024-08-20T12:00:00.000000Z' updated_at: type: string example: '2024-08-20T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/products': get: summary: 'Lista produtos' operationId: listaProdutos description: 'Endpoint para listar todos os produtos ativos' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 certificate_type: type: string example: A1 person_type: type: string example: PJ sku: type: integer example: 10 sisar_id: type: integer example: 1 name: type: string example: 'Certificado PJ A1' validate: type: integer example: 1 description: type: string example: 'Certificado PJ A1' min_price: type: string example: '10.00' max_price: type: string example: '199.99' status: type: boolean example: true slug: type: string example: certificado-pj-a1 is_ssl: type: boolean example: false created_at: type: string example: '2024-05-27T12:00:00.000000Z' updated_at: type: string example: '2024-05-27T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/products/fields': get: summary: 'Campos Dinâmico' operationId: camposDinmico description: 'Endpoint para retornar os campos dinâmicos vindos do SisAR' parameters: - in: query name: sku description: 'SKU do produto' example: '19052' required: true schema: type: string description: 'SKU do produto' example: '19052' - in: query name: product_id description: 'ID do produto no SisAR' example: '147' required: true schema: type: string description: 'ID do produto no SisAR' example: '147' - in: query name: only_required description: 'Filtrar somente campos dinâmicos obrigatórios' example: null required: false schema: type: boolean description: 'Filtrar somente campos dinâmicos obrigatórios' example: null - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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úmero)' value: '' required: false disable: false min_length: 0 max_length: 15 placeholder: 'RG (número) 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ítulo de eleitor (número)' value: '' required: false disable: false min_length: 0 max_length: 12 placeholder: 'Título de eleitor (número) do titular do Certificado' type: text values: null tooltip: null - id: te_zone name: te_zone label: 'Título de eleitor (zona eleitoral)' value: '' required: false disable: false min_length: 0 max_length: 3 placeholder: 'Título de eleitor (zona eleitoral) do titular do Certificado' type: text values: null tooltip: null - id: te_section name: te_section label: 'Título de eleitor (seção eleitoral)' value: '' required: false disable: false min_length: 0 max_length: 4 placeholder: 'Título de eleitor (seção eleitoral) do titular do Certificado' type: text values: null tooltip: null - id: te_city name: te_city label: 'Título de eleitor (município)' value: '' required: false disable: false min_length: 0 max_length: 20 placeholder: 'Título de eleitor (município) do titular do Certificado' type: text values: null tooltip: null - id: te_uf name: te_uf label: 'Título de eleitor (UF)' value: '' required: false disable: false min_length: 0 max_length: 2 placeholder: 'Título 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ífico 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úmero do PIS (Programa de Integração 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ódigo IBGE' value: '' required: true disable: false min_length: 1 max_length: 7 placeholder: 'Município do titular do Certificado' type: text values: null tooltip: null legal_person: - id: name name: name_pj label: 'Razão Social' value: '' required: true disable: false min_length: 3 max_length: 200 placeholder: 'Razão 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 properties: product: type: object properties: id: type: string example: '768' name: type: string example: 'ACS PJ A1 V5 G2 - SPRO CONTADORES' social_name: type: string example: 'CERTIFICADO PJ A1 SPRO CONTADORES' type: type: string example: J policy: type: string example: A1 class: type: string example: PJ profile: type: string example: legal_person months_validity: type: string example: '12' certificate_authority: type: string example: 'AC SOLUTI M v5 TESTE' issuer: type: object properties: url: type: string example: 'https://arsolutihom.acsoluti.com.br/site/emitircertificado/' fields: type: object properties: legal_person: type: object properties: physical_person: type: array example: - 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úmero)' value: '' required: false disable: false min_length: 0 max_length: 15 placeholder: 'RG (número) 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ítulo de eleitor (número)' value: '' required: false disable: false min_length: 0 max_length: 12 placeholder: 'Título de eleitor (número) do titular do Certificado' type: text values: null tooltip: null - id: te_zone name: te_zone label: 'Título de eleitor (zona eleitoral)' value: '' required: false disable: false min_length: 0 max_length: 3 placeholder: 'Título de eleitor (zona eleitoral) do titular do Certificado' type: text values: null tooltip: null - id: te_section name: te_section label: 'Título de eleitor (seção eleitoral)' value: '' required: false disable: false min_length: 0 max_length: 4 placeholder: 'Título de eleitor (seção eleitoral) do titular do Certificado' type: text values: null tooltip: null - id: te_city name: te_city label: 'Título de eleitor (município)' value: '' required: false disable: false min_length: 0 max_length: 20 placeholder: 'Título de eleitor (município) do titular do Certificado' type: text values: null tooltip: null - id: te_uf name: te_uf label: 'Título de eleitor (UF)' value: '' required: false disable: false min_length: 0 max_length: 2 placeholder: 'Título 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ífico 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úmero do PIS (Programa de Integração 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ódigo IBGE' value: '' required: true disable: false min_length: 1 max_length: 7 placeholder: 'Município do titular do Certificado' type: text values: null tooltip: null items: type: object properties: id: type: string example: name name: type: string example: name_pf label: type: string example: Nome value: type: string example: '' required: type: boolean example: true disable: type: boolean example: false min_length: type: integer example: 3 max_length: type: integer example: 200 placeholder: type: string example: 'Titular do Certificado' type: type: string example: text values: type: string example: null tooltip: type: string example: null legal_person: type: array example: - id: name name: name_pj label: 'Razão Social' value: '' required: true disable: false min_length: 3 max_length: 200 placeholder: 'Razão 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 items: type: object properties: id: type: string example: name name: type: string example: name_pj label: type: string example: 'Razão Social' value: type: string example: '' required: type: boolean example: true disable: type: boolean example: false min_length: type: integer example: 3 max_length: type: integer example: 200 placeholder: type: string example: 'Razão Social' type: type: string example: text values: type: string example: null tooltip: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/orders': get: summary: 'Listagem de Negociações' operationId: listagemDeNegociaes description: 'Endpoint para listar as Negociações' parameters: - in: query name: status description: 'Status da Negociação' example: null required: false schema: type: string description: 'Status da Negociação' example: null enum: - new - payment_pending - payment_confirmed - processing - approved_certificate - finished - canceled nullable: true - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: data: - id: 1 ulid: 01hz7rvnvaxfy0g5e9pnh0snpr type: purchase_order public_token: null order_id: null order_code: null status: id: 1 code: new label: Novo 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=1' last: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' prev: null next: 'https://api-contadores-evd.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-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' label: 'Próximo »' active: false path: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders' per_page: 1 to: 10 total: 2 properties: data: type: array example: - id: 1 ulid: 01hz7rvnvaxfy0g5e9pnh0snpr type: purchase_order public_token: null order_id: null order_code: null status: id: 1 code: new label: Novo 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hz7rvnvaxfy0g5e9pnh0snpr type: type: string example: purchase_order public_token: type: string example: null order_id: type: string example: null order_code: type: string example: null status: type: object properties: id: type: integer example: 1 code: type: string example: new label: type: string example: Novo status_date: type: string example: '2024-05-31T12:00:00.000000Z' obs: type: string example: null payment_modality: type: object properties: id: type: integer example: 1 name: type: string example: PAYMENT_ACCOUTING code: type: string example: INDIVIDUAL_SALE status: type: boolean example: true created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: '2024-05-31T12:00:00.000000Z' payment_method: type: string example: null company: type: object properties: id: type: integer example: 2 ulid: type: string example: 01hz7rpnnfdn3mhbdg3ktzbeqh status: type: boolean example: true type: type: string example: F registration_number: type: string example: '20261104330' alias: type: string example: 'Dr. Kevin Cléber Mascarenhas' name: type: string example: 'Dr. Kevin Cléber Mascarenhas' email: type: string example: beltrao.talita@matos.com phone: type: string example: '(95) 92039-2234' whatsapp: type: string example: '(74) 99868-3791' country_id: type: integer example: 537 country_name: type: string example: Brasil state_id: type: integer example: 416 state_name: type: string example: GO city_id: type: integer example: 953 city_name: type: string example: 'Senador Canedo' address: type: string example: 'Largo Abreu, 85. 859º Andar' number: type: string example: '8' complement: type: string example: 'Apto 729' neighborhood: type: string example: Nordeste postal_code: type: string example: 73427-169 all_customers_has_birdid: type: string example: null customer: type: object properties: id: type: integer example: 8 ulid: type: string example: 01hz7rpnnt9w8yaffzg9rmzkwm status: type: boolean example: true registration_number: type: string example: '58555228220' name: type: string example: 'Dr. Cristiano de Arruda Quintana Jr.' email: type: string example: qlourenco@example.org phone: type: string example: '97950235969' whatsapp: type: string example: '32967501838' bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-05-31 13:46:06' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: 'http://tamoio.com/et-et-ut-hic-deserunt-sint.html' created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: null amount: type: string example: '1810.53' details: type: array example: - 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' items: type: object properties: id: type: integer example: 1 product: type: object properties: id: type: integer example: 3 certificate_type: type: string example: A3 person_type: type: string example: PJ sku: type: integer example: 12 sisar_id: type: integer example: 2 name: type: string example: 'Certificado PJ A3' validate: type: integer example: 2 description: type: string example: 'Certificado PJ A3' min_price: type: string example: '10.00' max_price: type: string example: '199.99' status: type: boolean example: true slug: type: string example: certificado-pj-a3 is_ssl: type: boolean example: false created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: '2024-05-31T12:00:00.000000Z' solicitation_sisar: type: string example: null solicitation_link: type: string example: null original_unit_value: type: string example: '12.81' additional_unit_value: type: string example: '4.37' final_unit_value: type: string example: '17.18' quantity: type: integer example: 3 amount: type: string example: '51.54' product_fields: type: string example: null documentation_ok: type: string example: null validated_domain: type: string example: null created_at: type: string example: '2024-05-31T12:00:00.000000Z' links: type: object properties: first: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=1' last: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' prev: type: string example: null next: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 2 links: type: array example: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders?page=2' label: 'Próximo »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Anterior' active: type: boolean example: false path: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03sjcymkbtghxe7anjkj4v/orders' per_page: type: integer example: 1 to: type: integer example: 10 total: type: integer example: 2 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 post: summary: 'Cadastro de Negociação' operationId: cadastroDeNegociao description: 'Endpoint para cadastrar uma Negociação' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 201: description: Created content: application/json: schema: type: object example: 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: [] properties: order: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hz2hd34jx43p4ejkdjsksnmb type: type: string example: purchase_order public_token: type: string example: null order_id: type: string example: null order_code: type: string example: null status: type: object properties: id: type: integer example: 1 code: type: string example: new label: type: string example: Novo status_date: type: string example: '2024-06-05T12:00:00.000000Z' obs: type: string example: null created_at: type: string example: '2024-06-05T12:00:00.000000Z' updated_at: type: string example: null details: type: array example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: 'Tipo da Negociação' example: purchase_order enum: - purchase_order - sell_order obs: type: string description: 'Observações sobre a Negociação' example: null nullable: true payment_modality_id: type: integer description: 'ID da modalidade de pagamento' example: 1 company_id: type: string description: 'ID da Empresa vinculada a Organização (Contabilidade)' example: 1 customer_id: type: string description: 'ID do Cliente vinculado a Empresa' example: 1 negotiation: type: string description: 'Código da negociação do SDeal' example: null details: type: array description: 'Detalhes da negociação que serão vinculados a Negociação' example: - product_id: 1 additional_unit_value: '2.50' quantity: 1 items: type: object properties: product_id: type: integer description: 'ID do Produto' example: 1 additional_unit_value: type: string description: 'Valor adicional do Produto' example: '2.50' nullable: true quantity: type: string description: 'Quantidade de Produtos' example: 1 nullable: true product_fields: type: object description: '' example: null properties: { } nullable: true required: - product_id - quantity required: - type - payment_modality_id - details parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/orders/total-per-status': get: summary: 'Total de Negociações por Status' operationId: totalDeNegociaesPorStatus description: 'Endpoint para listar Total de Negociações por Status da Organização ou Empresa (Big Numbers)' parameters: - in: query name: company description: 'ULID da Empresa' example: 01jx03vsk2a58yw82g54cyvgzp required: false schema: type: string description: 'ULID da Empresa' example: 01jx03vsk2a58yw82g54cyvgzp nullable: true - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: new: 4 payment_pending: 1 payment_confirmed: 1 processing: 1 approved_certificate: 1 finished: 1 canceled: 1 properties: new: type: integer example: 4 payment_pending: type: integer example: 1 payment_confirmed: type: integer example: 1 processing: type: integer example: 1 approved_certificate: type: integer example: 1 finished: type: integer example: 1 canceled: type: integer example: 1 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/orders/{order_ulid}': get: summary: 'Mostrar uma Negociação' operationId: mostrarUmaNegociao description: 'Endpoint para mostrar uma Negociação da Organização ou Empresa pelo ULID' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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 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ço 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' properties: order: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hz2hd34jx43p4ejkdjsksnmb type: type: string example: purchase_order public_token: type: string example: null order_id: type: string example: null order_code: type: string example: null status: type: object properties: id: type: integer example: 1 code: type: string example: new label: type: string example: Novo status_date: type: string example: '2024-06-05T12:00:00.000000Z' obs: type: string example: null payment_modality: type: object properties: id: type: integer example: 1 name: type: string example: PAYMENT_ACCOUTING code: type: string example: INDIVIDUAL_SALE status: type: boolean example: true created_at: type: string example: '2024-06-04T12:00:00.000000Z' updated_at: type: string example: '2024-06-04T12:00:00.000000Z' payment_method: type: string example: null price: type: object properties: id: type: integer example: 21 name: type: string example: 'Preço Teste 1' slug: type: string example: preco-teste-1 status: type: string example: Rascunho start_date: type: string example: '2024-06-04T12:00:00.000000Z' end_date: type: string example: null link: type: string example: LINK_DOWNLOAD_PLANILHA production_range: type: object properties: id: type: integer example: 9 slug: type: string example: production-range-teste-1 start: type: integer example: 1 end: type: integer example: 5 status: type: boolean example: true description: type: string example: 'Production Range Teste 1' organization: type: object properties: id: type: integer example: 6 ulid: type: string example: 01hzhtew5jqkr4m9bmhgpsby08 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '33333333333333' alias: type: string example: 'Contabilidade A' name: type: string example: 'Contabilidade A' ulid_ar: type: string example: 01hzhtew25310zqk92ec5rm2gb ar_subdomain: type: string example: arpartnerhom theme: type: object properties: primary: type: string example: null secondary: type: string example: null logo: type: string example: null organization_type: type: object properties: id: type: integer example: 4 ulid: type: string example: 01j0trb4j2n6mg4z97y9x2gkve status: type: integer example: 1 code: type: string example: accounting name: type: string example: Contabilidade created_at: type: string example: '2024-06-20T12:00:00.000000Z' email: type: string example: contabilidade@soluti.com.br phone: type: string example: null whatsapp: type: string example: null country_id: type: string example: null state_id: type: string example: null city_id: type: string example: null address: type: string example: null number: type: string example: null complement: type: string example: null neighborhood: type: string example: null postal_code: type: string example: null company: type: object properties: id: type: integer example: 2 ulid: type: string example: 01hzhtf066f46650bpfv008bmv status: type: boolean example: true type: type: string example: F registration_number: type: string example: '30891275479' alias: type: string example: 'Marta Mascarenhas Sobrinho' name: type: string example: 'Marta Mascarenhas Sobrinho' email: type: string example: constancia.gusmao@fernandes.com.br phone: type: string example: '(19) 94025-8623' whatsapp: type: string example: '(67) 96389-5342' country_id: type: integer example: 470 country_name: type: string example: Brasil state_id: type: integer example: 895 state_name: type: string example: GO city_id: type: integer example: 544 city_name: type: string example: 'Senador Canedo' address: type: string example: 'Rua Rios, 4881' number: type: string example: '90' complement: type: string example: 'Bloco C' neighborhood: type: string example: Centro-Oeste postal_code: type: string example: 87213-085 all_customers_has_birdid: type: string example: null customer: type: object properties: id: type: integer example: 5 ulid: type: string example: 01hzhtf06c75dr8j1mhw2fhvse status: type: boolean example: true registration_number: type: string example: '06705751355' name: type: string example: 'Dr. Wellington Dante Carrara Sobrinho' email: type: string example: mariah15@example.net phone: type: string example: '54958049906' whatsapp: type: string example: '18970822194' bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-06-04 11:29:16' videoconference: type: object properties: verification: type: boolean example: true link: type: string example: 'https:\/\/salgado.com.br\/ut-voluptatem-laudantium-repudiandae-sit.html' created_at: type: string example: '2024-06-05T12:00:00.000000Z' updated_at: type: string example: null amount: type: string example: '387.22' details: type: array example: - 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' items: type: object properties: id: type: integer example: 50 product: type: object properties: id: type: integer example: 1 certificate_type: type: string example: A1 person_type: type: string example: PJ sku: type: integer example: 10 sisar_id: type: integer example: 1 name: type: string example: 'Certificado PJ A1' validate: type: integer example: 1 description: type: string example: 'Certificado PJ A1' min_price: type: string example: '10.00' max_price: type: string example: '199.99' status: type: boolean example: true slug: type: string example: certificado-pj-a1 is_ssl: type: boolean example: false created_at: type: string example: '2024-06-04T12:00:00.000000Z' updated_at: type: string example: '2024-06-04T12:00:00.000000Z' solicitation_sisar: type: string example: null solicitation_link: type: string example: null original_unit_value: type: string example: '10.99' additional_unit_value: type: string example: '5.99' final_unit_value: type: string example: '16.98' quantity: type: integer example: 5 amount: type: string example: '84.90' product_fields: type: string example: null documentation_ok: type: string example: null validated_domain: type: string example: null created_at: type: string example: '2024-06-05T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 delete: summary: 'Remover Negociação' operationId: removerNegociao description: 'Endpoint para remover uma Negociação' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 204: description: 'No Content' content: application/json: schema: type: array items: type: object example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: order_ulid description: 'ULID da Negociação' example: 01jx03vfwywqerx836r25qsycz required: true schema: type: string '/api/v1/organization/{ulid}/orders/{order_ulid}/cancel': delete: summary: 'Cancelar Negociação' operationId: cancelarNegociao description: 'Endpoint para cancelar uma negociação' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: order: id: 582 ulid: 01jjptp21d4jzwadx861ar2gvc status: id: 7 code: canceled label: Cancelado status_date: '2025-02-10T12:00:00.000000Z' type: sell_order created_at: '2025-01-28T12:00:00.000000Z' updated_at: null message: 'Negociação cancelada com sucesso' properties: order: type: object properties: id: type: integer example: 582 ulid: type: string example: 01jjptp21d4jzwadx861ar2gvc status: type: object properties: id: type: integer example: 7 code: type: string example: canceled label: type: string example: Cancelado status_date: type: string example: '2025-02-10T12:00:00.000000Z' type: type: string example: sell_order created_at: type: string example: '2025-01-28T12:00:00.000000Z' updated_at: type: string example: null message: type: string example: 'Negociação cancelada com sucesso' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: 'Negociação não pode ser cancelada.' errors: message: - 'Negociação não pode ser cancelada.' properties: message: type: string example: 'Negociação não pode ser cancelada.' errors: type: object properties: message: type: array example: - 'Negociação não pode ser cancelada.' items: type: string tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: order_ulid description: 'ULID do Pedido' example: 01jx03pfbaxpd1wmjv0h9srxd4 required: true schema: type: string '/api/v1/organization/{ulid}/orders/{order_ulid}/checkout-link': post: summary: 'Gerar Link de Checkout' operationId: gerarLinkDeCheckout description: 'Endpoint para gerar Checkout Link do Gestão Online' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: checkout-link: type: string example: 'https://checkout-hom.soluti.com.br/loja/checkout?callBackResponseUrl=http://api.omeuportal.com.br:8000/api/v1/webhook/order&t=ONTc5_MTcxNzYxNjM2MzIyNDE_I6OpqvAg4P2D06_bcG4XYw' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' 422: description: 'Unprocessable Content' content: application/json: schema: type: object example: message: '' errors: [] properties: message: type: string example: '' errors: type: array example: [] tags: - V1 get: summary: 'Mostrar Link de Checkout' operationId: mostrarLinkDeCheckout description: 'Endpoint para mostrar Checkout Link do Gestão Online' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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' properties: checkout-link: type: string example: 'https://checkout-hom.soluti.com.br/loja/checkout?callBackResponseUrl=http://api.omeuportal.com.br:8000/api/v1/webhook/order&t=ONTc5_MTcxNzYxNjM2MzIyNDE_I6OpqvAg4P2D06_bcG4XYw' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: order_ulid description: 'ULID do Pedido' example: 01jx03pws3mbrnrnry9ry8pyqm required: true schema: type: string '/api/v1/organization/{ulid}/stocks/total-per-status': get: summary: 'Total de Reserva por Status' operationId: totalDeReservaPorStatus description: 'Endpoint para listar Total de Reserva por Status' parameters: - in: query name: product_sku description: 'SKU do Produto' example: '10' required: false schema: type: integer description: 'SKU do Produto' example: '10' nullable: true - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: status: in_stock: 10 reserved: 20 total: 30 properties: status: type: object properties: in_stock: type: integer example: 10 reserved: type: integer example: 20 total: type: integer example: 30 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/stocks/total-per-product': get: summary: 'Total de Reserva por Produto' operationId: totalDeReservaPorProduto description: 'Endpoint para listar Total de Reserva por Produto' parameters: - in: query name: status description: 'Status da reserva' example: in_stock required: false schema: type: string description: 'Status da reserva' example: in_stock enum: - in_stock - reserved - used - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: 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 properties: data: type: array example: - 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 items: type: object properties: product: type: object properties: id: type: integer example: 2 name: type: string example: 'Certificado PJ A1 - Spro Contadores' sku: type: integer example: 19776 product_id_sisar: type: integer example: 310 stock: type: object properties: status: type: object properties: id: type: integer example: 1 name: type: string example: in_stock label: type: string example: 'Em Estoque' total: type: integer example: 1395 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/solicitations/total-per-status': get: summary: 'Total de Solicitações por Status' operationId: totalDeSolicitaesPorStatus description: 'Endpoint para listar Total de Solicitações por Status da Organização (Big Numbers) por CPF/CNPJ' parameters: - in: query name: registration_number description: 'CPF/CNPJ da Empresa' example: '81282527045' required: true schema: type: string description: 'CPF/CNPJ da Empresa' example: '81282527045' - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: pending: 41 active: 48 inactive: 125 expiring: 5 properties: pending: type: integer example: 41 active: type: integer example: 48 inactive: type: integer example: 125 expiring: type: integer example: 5 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string '/api/v1/organization/{ulid}/solicitations/{code}': get: summary: 'Mostrar uma Solicitação' operationId: mostrarUmaSolicitao description: 'Endpoint para mostrar uma Solicitação da Organização por código ' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: solicitation: code: 186719071053C126 common_name: 'FARIA E CAMPOS E FILHOS:23941629000131' cnpj: '23941629000131' owner: 'Faria e Campos e Filhos' name: '' cpf: '0' email: email@teste.com phone: '62999999999' county_id: '5208707' business_category: null status: '0' approved_at: '2025-07-12 11:10:10' spro_ulid_organization: organization_xpto1 spro_ulid_order: order_xpto1 properties: solicitation: type: object properties: code: type: string example: 186719071053C126 common_name: type: string example: 'FARIA E CAMPOS E FILHOS:23941629000131' cnpj: type: string example: '23941629000131' owner: type: string example: 'Faria e Campos e Filhos' name: type: string example: '' cpf: type: string example: '0' email: type: string example: email@teste.com phone: type: string example: '62999999999' county_id: type: string example: '5208707' business_category: type: string example: null status: type: string example: '0' approved_at: type: string example: '2025-07-12 11:10:10' spro_ulid_organization: type: string example: organization_xpto1 spro_ulid_order: type: string example: order_xpto1 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string - in: path name: code description: 'Código da Solicitação' example: '1867240510736592' required: true schema: type: string '/api/v1/organization/{ulid}/solicitations': get: summary: 'Listagem de Solicitações' operationId: listagemDeSolicitaes description: 'Endpoint para listar as Solicitações da Organização por CPF/CNPJ' parameters: - in: query name: registration_number description: 'CPF/CNPJ da Empresa' example: '23941629000131' required: true schema: type: string description: 'CPF/CNPJ da Empresa' example: '23941629000131' - in: query name: status description: 'Status das solicitações' example: null required: false schema: type: string description: 'Status das solicitações' example: null enum: - active - inactive - pending - expiring nullable: true - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: object example: data: - id: 1 code: 186719071053C126 name: 'Faria e Campos e Filhos' cnpj: '23941629000131' created_at: '2019-07-10 13:40:45' approved_at: '2019-07-10 13:58:24' expired_at: '2023-07-09 16:58:00' issued_at: '2019-07-10 14:01:19' situation: id: '4' description: Emitida updated_at: '2019-07-10 14:01:19' product: description: 'ACS PJ A1' profile: J validate: '12' sku: '10' is_ssl: false origin: id: '4' description: Videoconferência people: - type: Responsável name: 'Fulano de Tal' cpf: '22222222222' spro: organization_ulid: organization_xpto1 order_ulid: order_xpto1 - id: 2 code: 186719071053C127 name: 'Faria e Campos e Filhos 2' cnpj: '81282527045' created_at: '2019-07-10 13:40:45' approved_at: '2019-07-10 13:58:24' expired_at: '2023-07-09 16:58:00' issued_at: '2019-07-10 14:01:19' situation: id: '4' description: Emitida updated_at: '2019-07-10 14:01:19' product: description: 'ACS PF A1' profile: F validate: '12' sku: '9' origin: id: '4' description: Videoconferência people: - type: Titular name: 'Fulano de Tal' cpf: '22222222222' spro: organization_ulid: organization_xpto2 order_ulid: order_xpto2 links: first: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=1' last: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' prev: null next: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' meta: current_page: 1 from: 1 last_page: 2 links: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' label: 'Próximo »' active: false path: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations' per_page: 1 to: 10 total: 2 properties: data: type: array example: - id: 1 code: 186719071053C126 name: 'Faria e Campos e Filhos' cnpj: '23941629000131' created_at: '2019-07-10 13:40:45' approved_at: '2019-07-10 13:58:24' expired_at: '2023-07-09 16:58:00' issued_at: '2019-07-10 14:01:19' situation: id: '4' description: Emitida updated_at: '2019-07-10 14:01:19' product: description: 'ACS PJ A1' profile: J validate: '12' sku: '10' is_ssl: false origin: id: '4' description: Videoconferência people: - type: Responsável name: 'Fulano de Tal' cpf: '22222222222' spro: organization_ulid: organization_xpto1 order_ulid: order_xpto1 - id: 2 code: 186719071053C127 name: 'Faria e Campos e Filhos 2' cnpj: '81282527045' created_at: '2019-07-10 13:40:45' approved_at: '2019-07-10 13:58:24' expired_at: '2023-07-09 16:58:00' issued_at: '2019-07-10 14:01:19' situation: id: '4' description: Emitida updated_at: '2019-07-10 14:01:19' product: description: 'ACS PF A1' profile: F validate: '12' sku: '9' origin: id: '4' description: Videoconferência people: - type: Titular name: 'Fulano de Tal' cpf: '22222222222' spro: organization_ulid: organization_xpto2 order_ulid: order_xpto2 items: type: object properties: id: type: integer example: 1 code: type: string example: 186719071053C126 name: type: string example: 'Faria e Campos e Filhos' cnpj: type: string example: '23941629000131' created_at: type: string example: '2019-07-10 13:40:45' approved_at: type: string example: '2019-07-10 13:58:24' expired_at: type: string example: '2023-07-09 16:58:00' issued_at: type: string example: '2019-07-10 14:01:19' situation: type: object properties: id: type: string example: '4' description: type: string example: Emitida updated_at: type: string example: '2019-07-10 14:01:19' product: type: object properties: description: type: string example: 'ACS PJ A1' profile: type: string example: J validate: type: string example: '12' sku: type: string example: '10' is_ssl: type: boolean example: false origin: type: object properties: id: type: string example: '4' description: type: string example: Videoconferência people: type: array example: - type: Responsável name: 'Fulano de Tal' cpf: '22222222222' items: type: object properties: type: type: string example: Responsável name: type: string example: 'Fulano de Tal' cpf: type: string example: '22222222222' spro: type: object properties: organization_ulid: type: string example: organization_xpto1 order_ulid: type: string example: order_xpto1 links: type: object properties: first: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=1' last: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' prev: type: string example: null next: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 2 links: type: array example: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations?page=2' label: 'Próximo »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Anterior' active: type: boolean example: false path: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx04r2jwxpe1zjw73sx765pe/solicitations' per_page: type: integer example: 1 to: type: integer example: 10 total: type: integer example: 2 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden 404: description: 'Not Found' content: application/json: schema: type: object example: message: 'Not Found' properties: message: type: string example: 'Not Found' tags: - V1 parameters: - in: path name: ulid description: 'ULID da Organização' example: 01jx051j8n539qp7swab85mvza required: true schema: type: string /api/v1/webhook/order: post: summary: 'Cadastro de Pedido' operationId: cadastroDePedido description: 'Endpoint para cadastrar um Pedido' parameters: - in: header name: x-spro-authorization description: '' example: '{AUTHORIZATION_ACCESS_TOKEN}' schema: type: string responses: 200: description: OK content: application/json: schema: type: array items: type: object example: [] 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: event_id: type: string description: 'Tipo do evento do Gestão Online' example: FINANCIAL_PAYMENT_DISCHARGE enum: - ORDER_CREATED - ORDER_CANCEL - TAX_INVOICE_CHANGE_STATUS - FINANCIAL_PAYMENT_DISCHARGE - FINANCIAL_PAYMENT_STATUS - ORDER_DELIVERY_CHANGE_STATUS data: type: array description: 'Detalhes do pedido do Gestão Online' example: null items: type: object properties: id: type: integer description: 'ID do Pedido do Gestão Online' example: 100 required: - id required: - event_id - data /api/v1/orders: get: summary: 'Listagem de Negociações' operationId: listagemDeNegociaes description: 'Endpoint para listar as Negociações' parameters: - in: query name: status description: 'Status da Negociação' example: null required: false schema: type: string description: 'Status da Negociação' example: null enum: - new - payment_pending - payment_confirmed - processing - approved_certificate - finished - canceled nullable: true responses: 200: description: OK content: application/json: schema: type: object example: data: - id: 1 ulid: 01hz7rvnvaxfy0g5e9pnh0snpr type: purchase_order public_token: null order_id: null order_code: null status: id: 1 code: new label: Novo 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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-evd.solutipro.com.br/api/v1/orders?page=1' last: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' prev: null next: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' meta: current_page: 1 from: 1 last_page: 2 links: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' label: 'Próximo »' active: false path: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders' per_page: 1 to: 10 total: 2 properties: data: type: array example: - id: 1 ulid: 01hz7rvnvaxfy0g5e9pnh0snpr type: purchase_order public_token: null order_id: null order_code: null status: id: 1 code: new label: Novo 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' 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éber Mascarenhas' name: 'Dr. Kevin Cléber 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º 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' items: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hz7rvnvaxfy0g5e9pnh0snpr type: type: string example: purchase_order public_token: type: string example: null order_id: type: string example: null order_code: type: string example: null status: type: object properties: id: type: integer example: 1 code: type: string example: new label: type: string example: Novo status_date: type: string example: '2024-05-31T12:00:00.000000Z' obs: type: string example: null payment_modality: type: object properties: id: type: integer example: 1 name: type: string example: PAYMENT_ACCOUTING code: type: string example: INDIVIDUAL_SALE status: type: boolean example: true created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: '2024-05-31T12:00:00.000000Z' payment_method: type: string example: null company: type: object properties: id: type: integer example: 2 ulid: type: string example: 01hz7rpnnfdn3mhbdg3ktzbeqh status: type: boolean example: true type: type: string example: F registration_number: type: string example: '20261104330' alias: type: string example: 'Dr. Kevin Cléber Mascarenhas' name: type: string example: 'Dr. Kevin Cléber Mascarenhas' email: type: string example: beltrao.talita@matos.com phone: type: string example: '(95) 92039-2234' whatsapp: type: string example: '(74) 99868-3791' country_id: type: integer example: 537 country_name: type: string example: Brasil state_id: type: integer example: 416 state_name: type: string example: GO city_id: type: integer example: 953 city_name: type: string example: 'Senador Canedo' address: type: string example: 'Largo Abreu, 85. 859º Andar' number: type: string example: '8' complement: type: string example: 'Apto 729' neighborhood: type: string example: Nordeste postal_code: type: string example: 73427-169 all_customers_has_birdid: type: string example: null customer: type: object properties: id: type: integer example: 8 ulid: type: string example: 01hz7rpnnt9w8yaffzg9rmzkwm status: type: boolean example: true registration_number: type: string example: '58555228220' name: type: string example: 'Dr. Cristiano de Arruda Quintana Jr.' email: type: string example: qlourenco@example.org phone: type: string example: '97950235969' whatsapp: type: string example: '32967501838' bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-05-31 13:46:06' videoconference: type: object properties: verification: type: boolean example: false link: type: string example: 'http://tamoio.com/et-et-ut-hic-deserunt-sint.html' created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: null amount: type: string example: '1810.53' details: type: array example: - 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' items: type: object properties: id: type: integer example: 1 product: type: object properties: id: type: integer example: 3 certificate_type: type: string example: A3 person_type: type: string example: PJ sku: type: integer example: 12 sisar_id: type: integer example: 2 name: type: string example: 'Certificado PJ A3' validate: type: integer example: 2 description: type: string example: 'Certificado PJ A3' min_price: type: string example: '10.00' max_price: type: string example: '199.99' status: type: boolean example: true slug: type: string example: certificado-pj-a3 is_ssl: type: boolean example: false created_at: type: string example: '2024-05-31T12:00:00.000000Z' updated_at: type: string example: '2024-05-31T12:00:00.000000Z' solicitation_sisar: type: string example: null solicitation_link: type: string example: null original_unit_value: type: string example: '12.81' additional_unit_value: type: string example: '4.37' final_unit_value: type: string example: '17.18' quantity: type: integer example: 3 amount: type: string example: '51.54' product_fields: type: string example: null documentation_ok: type: string example: null validated_domain: type: string example: null created_at: type: string example: '2024-05-31T12:00:00.000000Z' links: type: object properties: first: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=1' last: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' prev: type: string example: null next: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 2 links: type: array example: - url: null label: '« Anterior' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=1' label: '1' active: true - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' label: '2' active: false - url: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders?page=2' label: 'Próximo »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Anterior' active: type: boolean example: false path: type: string example: 'https://api-contadores-evd.solutipro.com.br/api/v1/orders' per_page: type: integer example: 1 to: type: integer example: 10 total: type: integer example: 2 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 '/api/v1/orders/{order_ulid}': get: summary: 'Mostrar uma Negociação' operationId: mostrarUmaNegociao description: 'Endpoint para mostrar uma Negociação pelo ULID' parameters: [] responses: 200: description: OK content: application/json: schema: type: object example: 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 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ço 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' properties: order: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hz2hd34jx43p4ejkdjsksnmb type: type: string example: purchase_order public_token: type: string example: null order_id: type: string example: null order_code: type: string example: null status: type: object properties: id: type: integer example: 1 code: type: string example: new label: type: string example: Novo status_date: type: string example: '2024-06-05T12:00:00.000000Z' obs: type: string example: null payment_modality: type: object properties: id: type: integer example: 1 name: type: string example: PAYMENT_ACCOUTING code: type: string example: INDIVIDUAL_SALE status: type: boolean example: true created_at: type: string example: '2024-06-04T12:00:00.000000Z' updated_at: type: string example: '2024-06-04T12:00:00.000000Z' payment_method: type: string example: null price: type: object properties: id: type: integer example: 21 name: type: string example: 'Preço Teste 1' slug: type: string example: preco-teste-1 status: type: string example: Rascunho start_date: type: string example: '2024-06-04T12:00:00.000000Z' end_date: type: string example: null link: type: string example: LINK_DOWNLOAD_PLANILHA production_range: type: object properties: id: type: integer example: 9 slug: type: string example: production-range-teste-1 start: type: integer example: 1 end: type: integer example: 5 status: type: boolean example: true description: type: string example: 'Production Range Teste 1' organization: type: object properties: id: type: integer example: 6 ulid: type: string example: 01hzhtew5jqkr4m9bmhgpsby08 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '33333333333333' alias: type: string example: 'Contabilidade A' name: type: string example: 'Contabilidade A' ulid_ar: type: string example: 01hzhtew25310zqk92ec5rm2gb ar_subdomain: type: string example: arpartnerhom theme: type: object properties: primary: type: string example: null secondary: type: string example: null logo: type: string example: null organization_type: type: object properties: id: type: integer example: 4 ulid: type: string example: 01j0trb4j2n6mg4z97y9x2gkve status: type: integer example: 1 code: type: string example: accounting name: type: string example: Contabilidade created_at: type: string example: '2024-06-20T12:00:00.000000Z' email: type: string example: contabilidade@soluti.com.br phone: type: string example: null whatsapp: type: string example: null country_id: type: string example: null state_id: type: string example: null city_id: type: string example: null address: type: string example: null number: type: string example: null complement: type: string example: null neighborhood: type: string example: null postal_code: type: string example: null company: type: object properties: id: type: integer example: 2 ulid: type: string example: 01hzhtf066f46650bpfv008bmv status: type: boolean example: true type: type: string example: F registration_number: type: string example: '30891275479' alias: type: string example: 'Marta Mascarenhas Sobrinho' name: type: string example: 'Marta Mascarenhas Sobrinho' email: type: string example: constancia.gusmao@fernandes.com.br phone: type: string example: '(19) 94025-8623' whatsapp: type: string example: '(67) 96389-5342' country_id: type: integer example: 470 country_name: type: string example: Brasil state_id: type: integer example: 895 state_name: type: string example: GO city_id: type: integer example: 544 city_name: type: string example: 'Senador Canedo' address: type: string example: 'Rua Rios, 4881' number: type: string example: '90' complement: type: string example: 'Bloco C' neighborhood: type: string example: Centro-Oeste postal_code: type: string example: 87213-085 all_customers_has_birdid: type: string example: null customer: type: object properties: id: type: integer example: 5 ulid: type: string example: 01hzhtf06c75dr8j1mhw2fhvse status: type: boolean example: true registration_number: type: string example: '06705751355' name: type: string example: 'Dr. Wellington Dante Carrara Sobrinho' email: type: string example: mariah15@example.net phone: type: string example: '54958049906' whatsapp: type: string example: '18970822194' bird_id: type: object properties: is_valid: type: boolean example: false verified_at: type: string example: '2024-06-04 11:29:16' videoconference: type: object properties: verification: type: boolean example: true link: type: string example: 'https:\/\/salgado.com.br\/ut-voluptatem-laudantium-repudiandae-sit.html' created_at: type: string example: '2024-06-05T12:00:00.000000Z' updated_at: type: string example: null amount: type: string example: '387.22' details: type: array example: - 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' items: type: object properties: id: type: integer example: 50 product: type: object properties: id: type: integer example: 1 certificate_type: type: string example: A1 person_type: type: string example: PJ sku: type: integer example: 10 sisar_id: type: integer example: 1 name: type: string example: 'Certificado PJ A1' validate: type: integer example: 1 description: type: string example: 'Certificado PJ A1' min_price: type: string example: '10.00' max_price: type: string example: '199.99' status: type: boolean example: true slug: type: string example: certificado-pj-a1 is_ssl: type: boolean example: false created_at: type: string example: '2024-06-04T12:00:00.000000Z' updated_at: type: string example: '2024-06-04T12:00:00.000000Z' solicitation_sisar: type: string example: null solicitation_link: type: string example: null original_unit_value: type: string example: '10.99' additional_unit_value: type: string example: '5.99' final_unit_value: type: string example: '16.98' quantity: type: integer example: 5 amount: type: string example: '84.90' product_fields: type: string example: null documentation_ok: type: string example: null validated_domain: type: string example: null created_at: type: string example: '2024-06-05T12:00:00.000000Z' 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 parameters: - in: path name: order_ulid description: 'ULID da Negociação' example: 01jx03tspz4yzqdb5x9rz6vs0t required: true schema: type: string /api/v1/onboarding-digital: post: summary: 'Cadastro de Organização' operationId: cadastroDeOrganizao description: 'Endpoint para cadastrar uma Organização via Onboarding Digital' parameters: [] responses: 201: description: Created content: application/json: schema: type: object example: 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 properties: organization: type: object properties: id: type: integer example: 1 ulid: type: string example: 01hska5h7gfzjh4vz9e2wa04m3 status: type: boolean example: true type: type: string example: J registration_number: type: string example: '19640726000117' alias: type: string example: 'Aguiar e Associados' name: type: string example: 'Aguiar e Associados' ar_subdomain: type: string example: uchoa.net.br email: type: string example: julia.alcantara@burgos.br phone: type: string example: '(97) 97317-3799' whatsapp: type: string example: '(75) 94533-8056' country_id: type: integer example: 181 state_id: type: integer example: 719 city_id: type: integer example: 281 address: type: string example: 'Av. Carlos, 609. Bloco A' number: type: string example: '784' complement: type: string example: 'Apto 5' neighborhood: type: string example: Norte postal_code: type: string example: 70033-161 production_range: type: string example: null price: type: string example: null products: type: string example: null payment_modalities: type: string example: null 401: description: Unauthorized content: application/json: schema: type: object example: message: Unauthorized properties: message: type: string example: Unauthorized 403: description: Forbidden content: application/json: schema: type: object example: message: Forbidden properties: message: type: string example: Forbidden tags: - V1 requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: 'Tipo da Organização' example: J enum: - F - J registration_number: type: string description: 'CPF/CNPJ da Organização' example: '19640726000117' alias: type: string description: 'Alias da Organização' example: 'Aguiar e Associados' name: type: string description: 'Nome da Organização' example: 'Aguiar e Associados' phone: type: string description: 'Telefone/Celular da Organização' example: '(97) 97317-3799' nullable: true whatsapp: type: string description: 'Whatsapp da Organização' example: '(75) 94533-8056' nullable: true email: type: string description: 'E-mail da Organização' example: julia.alcantara@burgos.br nullable: true ar_subdomain: type: string description: 'Subdomínio da AR da Organização' example: arsoluti nullable: true country_id: type: integer description: 'ID do País da Organização' example: '181' nullable: true country_name: type: string description: 'Nome do País da Organização' example: Brasil nullable: true state_id: type: integer description: 'ID do Estado da Organização' example: '719' nullable: true state_name: type: string description: 'UF do Estado da Organização' example: GO enum: - AC - AL - AP - AM - BA - CE - DF - ES - GO - MA - MT - MS - MG - PA - PB - PR - PE - PI - RJ - RN - RS - RO - RR - SC - SP - SE - TO nullable: true city_id: type: integer description: 'Código IBGE da Cidade da Organização' example: '281' nullable: true city_name: type: string description: 'Nome da Cidade da Organização' example: Goiânia nullable: true neighborhood: type: string description: 'Bairro da Organização' example: Norte nullable: true postal_code: type: string description: 'CEP da Organização' example: 70033-161 nullable: true address: type: string description: Endereço example: 'Av. Carlos, 609. Bloco A' nullable: true number: type: string description: Número example: '784' nullable: true complement: type: string description: Complemento example: 'Apto 5' nullable: true price_id: type: integer description: 'ID do Preço da Organização (Obrigatório para Vendedor e Contabilidade)' example: '1' organization_type_code: type: string description: 'Perfil da Organização' example: accounting products_skus: type: array description: 'SKUs dos produtos que serão vinculados a Organização' example: - 10 - 11 - 12 items: type: integer nullable: true payment_modalities_code: type: array description: 'Modalidades de pagamentos que serão vinculadas a Organização' example: - PAYMENT_ACCOUNTING - PAYMENT_CUSTOMER - DEBIT_STOCK - PRE_PAID_VOUCHER - POST_PAID_VOUCHER items: type: string nullable: true recaptcha-token: type: string description: 'ReCaptcha Token' example: '' users: type: array description: 'Usuários que serão cadastrados a Organização' example: '' items: type: object nullable: true properties: name: type: string description: 'Nome do Usuário' example: 'Fulano de Tal' email: type: string description: 'E-mail do Usuário' example: usuario@teste.com.br registration_number: type: string description: 'CPF do Usuário' example: '11122233344' phone: type: string description: 'Telefone/Celular do Usuário' example: (11)99999-9999 nullable: true whatsapp: type: string description: 'Whatsapp do Usuário' example: (11)99999-9999 nullable: true required: - name - email - registration_number required: - type - registration_number - alias - name - email - organization_type_code - recaptcha-token security: []