Introdução

API Soluti PRO - EVD para integração entre Frontend, Sistema de ARs e Bird ID.

Essa documentação tem como objetivo repassar as informações dos endpoints da api para integração.

Autenticando requisições

Para autenticar requisições, inclua os cabeçalhos:

Authorization com o valor "Bearer {AUTHENTICATE_ACCESS_TOKEN}", obtido no endpoint Autenticação

x-spro-authorization com o valor "{AUTHORIZATION_ACCESS_TOKEN}", obtido no endpoint Autorização

Todos os endpoints autenticados são marcados com um selo requires authentication na documentação abaixo.

API

Health

Recursos relacionados a saúde da API


Check

GET
https://api-contadores-evd.solutipro.com.br
/api/health

Endpoint de Health Check

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/health" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

V1

Autenticação e Autorização

Recursos relacionados a Autenticação e Autorização da API


Logout

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/auth/logout
requires authentication

Invalidar o Token.

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/auth/logout" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
[]
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Refresh Token

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/auth/refresh
requires authentication

Gerar novo Token sem necessidade de uma nova autenticação.

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/auth/refresh" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0",
    "token_type": "Bearer",
    "expires_in": 86400
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Login

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/auth/login

Realizar Autenticação na API.

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"registration_number\": \"12345678919\",
    \"password\": [
        \"123456\",
        \"9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be\"
    ]
}"
Resposta de exemplo:

Autenticação

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/auth/birdid

Realizar Autenticação na API.

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/auth/birdid" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"registration_number\": \"12345678919\",
    \"password\": [
        \"123456\",
        \"9d654d72-c7d0-4aa0-b9f2-bc786d9ee5be\"
    ]
}"
Resposta de exemplo:
{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0",
    "token_type": "Bearer",
    "expires_in": 86400
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Autorização

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/auth/authorization
requires authentication

Realizar Autorização na API.

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/auth/authorization" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vYXBpZGV2Lm1ldXBvcnRhbC5jb20uYnI6ODAwMC9hcGkvdjEvYXV0aC9sb2dpbiIsImlhdCI6MTcwODQ2MTAyMiwiZXhwIjoxNzA4NTQ3NDIyLCJuYmYiOjE3MDg0NjEwMjIsImp0aSI6InozTzNxaHYxM2ZldmNLc2MiLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsIm9yZ2FuaXphdGlvbnMiOlt7ImlkIjoxLCJ1bGlkIjoiMDFIUTQzQk4wUjRIUDFIRkM4MERGNzBKNDQiLCJ0eXBlIjoiSiIsInJlZ2lzdHJhdGlvbl9udW1iZXIiOiIwMTE2NzIxMzAwMDE3NSIsImFsaWFzIjoiUm9vdCIsIm5hbWUiOiJSb290IiwicGhvbmUiOiI3NDQ4OTM2NzM5Iiwid2hhdHNhcHAiOiI1NDk3Mzg5NDA0MyIsImVtYWlsIjoiZmxhdmlvMzZAaWcuY29tLmJyIiwiYXJfc3ViZG9tYWluIjpudWxsLCJjb3VudHJ5X2lkIjo1NzYsImNvdW50cnlfbmFtZSI6IlBhbGFvcyIsInN0YXRlX2lkIjo5Nywic3RhdGVfbmFtZSI6Ik1hdG8gR3Jvc3NvIGRvIFN1bCIsImNpdHlfaWQiOjQ2NywiY2l0eV9uYW1lIjoiVmlsYSBFcmljIiwibmVpZ2hib3Job29kIjoiU3VsIiwicG9zdGFsX2NvZGUiOiIxNDIxOC02MjMiLCJhZGRyZXNzIjpudWxsLCJudW1iZXIiOm51bGwsImNvbXBsZW1lbnQiOm51bGwsInN0YXR1cyI6MSwib3JnYW5pemF0aW9uX3R5cGVfaWQiOjEsInBhcmVudF9vcmdhbml6YXRpb25faWQiOm51bGwsImNyZWF0ZWRfYXQiOiIyMDI0LTAyLTIwVDIwOjI5OjQ3LjAwMDAwMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwicGl2b3QiOnsidXNlcl9pZCI6MSwib3JnYW5pemF0aW9uX2lkIjoxfSwib3JnYW5pemF0aW9uX3R5cGUiOnsiaWQiOjEsInVsaWQiOiIwMUhRNDNCTVlSMlpNS1ZSWVY1RVFYOUU4WCIsIm5hbWUiOiJSb290Iiwic3RhdHVzIjoxLCJjcmVhdGVkX2J5IjpudWxsLCJ1cGRhdGVkX2J5IjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0yMFQyMDoyOTo0Ny4wMDAwMDBaIiwidXBkYXRlZF9hdCI6IjIwMjQtMDItMjBUMjA6Mjk6NDcuMDAwMDAwWiIsInJvbGVzIjpbXX19XX0.cmF123VHHj7pt-M1TbvmFAUYVzVVVxCzauk1TjkT2p0",
    "token_type": "Bearer",
    "expires_in": 86400
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Organização

Recursos relacionados a gerenciamento de Organizações da API


Visualizar uma Organização

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}
requires authentication

Endpoint para mostrar uma Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": []
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Atualizar a Organização logada

PUT
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}
requires authentication

Endpoint para atualizar a Organização logada

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request PUT \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": true,
    \"alias\": \"Aguiar e Associados\",
    \"name\": \"Aguiar e Associados\",
    \"phone\": \"(97) 97317-3799\",
    \"whatsapp\": \"(75) 94533-8056\",
    \"email\": \"[email protected]\",
    \"country_id\": \"181\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"719\",
    \"state_name\": \"GO\",
    \"city_id\": \"281\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Norte\",
    \"postal_code\": \"70033-161\",
    \"address\": \"Av. Carlos, 609. Bloco A\",
    \"number\": \"784\",
    \"complement\": \"Apto 5\",
    \"price_id\": \"1\",
    \"production_range_id\": \"1\"
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": []
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Listagem de Organizações filhas

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/organizations
requires authentication

Endpoint para listar as Organizações filhas

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

with_oldest_user
string
with_users
string
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/organizations" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
            "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": "[email protected]",
            "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": []
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Cadastro de Organização

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/organizations
requires authentication

Endpoint para cadastrar uma Organização FILHA

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/organizations" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"J\",
    \"registration_number\": \"19640726000117\",
    \"alias\": \"Aguiar e Associados\",
    \"name\": \"Aguiar e Associados\",
    \"phone\": \"(97) 97317-3799\",
    \"whatsapp\": \"(75) 94533-8056\",
    \"email\": \"[email protected]\",
    \"ar_subdomain\": \"arsoluti\",
    \"country_id\": \"181\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"719\",
    \"state_name\": \"GO\",
    \"city_id\": \"281\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Norte\",
    \"postal_code\": \"70033-161\",
    \"address\": \"Av. Carlos, 609. Bloco A\",
    \"number\": \"784\",
    \"complement\": \"Apto 5\",
    \"price_id\": \"1\",
    \"organization_type_code\": \"accounting\",
    \"products_skus\": [
        10,
        11,
        12
    ],
    \"payment_modalities_code\": [
        \"PAYMENT_ACCOUNTING\",
        \"PAYMENT_CUSTOMER\",
        \"DEBIT_STOCK\",
        \"PRE_PAID_VOUCHER\",
        \"POST_PAID_VOUCHER\"
    ],
    \"users\": [
        {
            \"name\": \"Fulano de Tal\",
            \"email\": \"[email protected]\",
            \"registration_number\": \"11122233344\",
            \"phone\": \"(11)99999-9999\",
            \"whatsapp\": \"(11)99999-9999\"
        }
    ]
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Visualizar uma Organização filha

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/organizations/{child_ulid}
requires authentication

Endpoint para mostrar uma Organização FILHA

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
child_ulid
string
required

ULID da Organização FILHA

Example:
01jx04hzemzdpx07k34bhers9b

Parâmetros da Query String

with_oldest_user
string
with_users
string
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/organizations/01jx04hzemzdpx07k34bhers9b" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": []
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Atualizar uma Organização filha

PUT
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/organizations/{child_ulid}
requires authentication

Endpoint para atualizar uma Organização FILHA

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
child_ulid
string
required

ULID da Organização FILHA

Example:
01jx04k797ntvq2p2azy8rycz9

Parâmetros do Body

Requisição de exemplo:
curl --request PUT \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/organizations/01jx04k797ntvq2p2azy8rycz9" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": true,
    \"alias\": \"Aguiar e Associados\",
    \"name\": \"Aguiar e Associados\",
    \"phone\": \"(97) 97317-3799\",
    \"whatsapp\": \"(75) 94533-8056\",
    \"email\": \"[email protected]\",
    \"country_id\": \"181\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"719\",
    \"state_name\": \"GO\",
    \"city_id\": \"281\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Norte\",
    \"postal_code\": \"70033-161\",
    \"address\": \"Av. Carlos, 609. Bloco A\",
    \"number\": \"784\",
    \"complement\": \"Apto 5\",
    \"price_id\": \"1\",
    \"production_range_id\": \"1\",
    \"users\": [
        {
            \"name\": \"Fulano de Tal\",
            \"email\": \"[email protected]\",
            \"registration_number\": \"11122233344\",
            \"phone\": \"(11)99999-9999\",
            \"whatsapp\": \"(11)99999-9999\"
        }
    ]
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": []
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Usuário

Recursos relacionados a gerenciamento de Usuários da API


Alterar usuário logado

PUT
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/users/logged
requires authentication

Endpoint para alterar o usuário logado

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request PUT \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/users/logged" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Fulano de Tal\",
    \"email\": \"[email protected]\",
    \"phone\": \"(11)99999-9999\"
}"
Resposta de exemplo:
{
    "user": {
        "ulid": "01hskccmp33ztvmgf2aa4wcb2k",
        "name": "Dr. Vicente Velasques Sandoval",
        "email": "[email protected]",
        "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Buscar dados do usuário logado

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/users/logged
requires authentication

Endpoint para buscar dados do usuário logado

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/users/logged" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "user": {
        "ulid": "01hskccmp33ztvmgf2aa4wcb2k",
        "name": "Dr. Vicente Velasques Sandoval",
        "email": "[email protected]",
        "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Buscar usuário por CPF

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/users/{registration_number}
requires authentication

Endpoint para buscar um usuário por CPF

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
registration_number
string
required

CPF do Usuário

Example:
37194478200
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/users/37194478200" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "user": {
        "ulid": "01hskccmp33ztvmgf2aa4wcb2k",
        "name": "Dr. Vicente Velasques Sandoval",
        "email": "[email protected]",
        "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Empresa

Recursos relacionados a gerenciamento de Empresas vinculadas a uma Organização da API


Listagem de Empresas

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/companies
requires authentication

Endpoint para mostrar todos, ou por filtro, os clientes da Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

filter
string

Filtro do autocomplete, CPF/CNPJ ou Nome

order
object

Tipos de Ordenação. consiste em um array, contendo coluna e direção.

Example:
{"column":"name","direction":"asc"}
order.column
string
Must be one of:
  • name
  • alias
Example:
quia
order.direction
string
Must be one of:
  • asc
  • desc
Example:
consequatur
status
string

Filtrar empresas ativas/inativas

Must be one of:
  • all
  • active
  • inactive
Example:
facilis
customers
string

Retorna os representantes legais da Empresa

Must be one of:
  • all
  • with_bird_id
  • without_bird_id
Example:
ut
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/companies?order[column]=name&order[direction]=asc&status=facilis&customers=ut" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "data": [
        {
            "id": 1,
            "ulid": "01hsk870t6gvtst3jnckpn6wwk",
            "status": true,
            "type": "J",
            "registration_number": "44252837000101",
            "alias": "Rezende Comercial Ltda.",
            "name": "Rezende Comercial Ltda.",
            "email": "[email protected]",
            "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": "[email protected]",
            "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Cadastro de Empresa

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/companies
requires authentication

Endpoint para cadastrar uma Empresa vinculada a uma Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/companies" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"J\",
    \"registration_number\": \"58312998000140\",
    \"alias\": \"Barreto e Rodrigues e Filhos\",
    \"name\": \"Barreto e Rodrigues e Filhos\",
    \"phone\": \"(87) 90410-2583\",
    \"whatsapp\": \"(22) 98676-2512\",
    \"email\": \"[email protected]\",
    \"country_id\": \"846\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"397\",
    \"state_name\": \"GO\",
    \"city_id\": \"196\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Sul\",
    \"postal_code\": \"95765-846\",
    \"address\": \"Largo Renan, 2. Bloco C\",
    \"number\": \"68111\",
    \"complement\": \"Bc. 8 Ap. 47\",
    \"customer\": {
        \"name\": \"Fulano de Tal\",
        \"email\": \"[email protected]\",
        \"registration_number\": \"81282527045\",
        \"phone\": \"(62)98178-0000\",
        \"whatsapp\": \"(11)99999-9999\"
    }
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": "[email protected]",
                "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
                }
            }
        ]
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Visualizar uma Empresa

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/companies/{company_ulid}
requires authentication

Endpoint para visualizar uma Empresa vinculada a uma Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
company_ulid
string
required

ULID da Empresa

Example:
01jx03kv1m7fccbs5brakp82rq
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/companies/01jx03kv1m7fccbs5brakp82rq" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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": "[email protected]",
                "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
                }
            }
        ]
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Atualização de Empresas

PUT
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/companies/{company_ulid}
requires authentication

Endpoint para atualizar uma Empresa vinculada a uma Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
company_ulid
string
required

ULID da Empresa

Example:
01jx03mfwftwchtreyczb5q497

Parâmetros do Body

Requisição de exemplo:
curl --request PUT \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/companies/01jx03mfwftwchtreyczb5q497" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": false,
    \"alias\": \"Barreto e Rodrigues e Filhos\",
    \"name\": \"Barreto e Rodrigues e Filhos\",
    \"phone\": \"(87) 90410-2583\",
    \"whatsapp\": \"(22) 98676-2512\",
    \"email\": \"[email protected]\",
    \"country_id\": \"846\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"397\",
    \"state_name\": \"GO\",
    \"city_id\": \"196\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Sul\",
    \"postal_code\": \"95765-846\",
    \"address\": \"Largo Renan, 2. Bloco C\",
    \"number\": \"68111\",
    \"complement\": \"Bc. 8 Ap. 47\",
    \"customers\": [
        {
            \"name\": \"Fulano de Tal\",
            \"email\": \"[email protected]\",
            \"registration_number\": \"81282527045\",
            \"phone\": \"(62)98178-0000\",
            \"status\": true
        },
        {
            \"name\": \"Beltrano de Tal\",
            \"email\": \"[email protected]\",
            \"registration_number\": \"81282527045\",
            \"phone\": \"(62)98178-0000\",
            \"status\": false
        }
    ]
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Desativar Empresa

DELETE
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/companies/{company_ulid}
requires authentication

Endpoint para desativar a Empresa de uma Organização

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
company_ulid
string
required

ULID da Empresa

Example:
01jx03j9vmtydhyh2ba8h8ezw7
Requisição de exemplo:
curl --request DELETE \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/companies/01jx03j9vmtydhyh2ba8h8ezw7" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
[Resposta vazia]
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Cliente

Recursos relacionados a gerenciamento de Organizações da API


Validar Bird Id Cliente

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/customers/{registration_number}/validate-birdid
requires authentication

Endpoint para validar Bird ID do Cliente.

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx03nn8zg7pyg28408sk73am
registration_number
string
required

CPF do Usuário

Example:
37194478200
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03nn8zg7pyg28408sk73am/customers/37194478200/validate-birdid" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "bird_id": {
        "is_valid": true
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/customers/{customer_ulid}/send-video-conference-link
requires authentication

Endpoint para enviar e-mail com link de Videoconferência para o Cliente.

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx03n1dy9b7eqq4xs8h8zj87
customer_ulid
string
required

ULID do Cliente

Example:
01jx03nadphsr85f8kh70tehac
Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx03n1dy9b7eqq4xs8h8zj87/customers/01jx03nadphsr85f8kh70tehac/send-video-conference-link" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:

Faixa de Produção

Recursos relacionados a gerenciamento de Faixa de Produção da API


Cadastro de Faixa de Produção

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/production-ranges
requires authentication

Endpoint para cadastrar uma faixa de produção (Organização do tipo AR)

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/production-ranges" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"1 até 100\",
    \"start\": 1,
    \"end\": 100,
    \"status\": true
}"
Resposta de exemplo:
{
    "production_range": {
        "id": 1,
        "slug": "1-ate-100",
        "start": 1,
        "end": 100,
        "status": true,
        "description": "1 até 100"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Lista Faixa de Produção

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/production-ranges
requires authentication

Endpoint para listar as faixas de produções associada a uma AR

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/production-ranges" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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"
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Atualizar Faixa de Produção

PUT
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/production-ranges/{production_range_id}
requires authentication

Endpoint para cadastrar uma faixa de produção (Organização do tipo AR)

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
production_range_id
integer
required

ID da Faixa de Produção

Example:
1

Parâmetros do Body

Requisição de exemplo:
curl --request PUT \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/production-ranges/1" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"1 até 100\",
    \"status\": true,
    \"start\": 1,
    \"end\": 100
}"
Resposta de exemplo:
{
    "production_range": {
        "id": 1,
        "slug": "1-ate-100",
        "start": 1,
        "end": 100,
        "status": true,
        "description": "1 até 100"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Tabela de Preço

Recursos relacionados a gerenciamento de Tabela de Preços


Cadastro de Preços

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/prices
requires authentication

Endpoint para cadastrar um preço com seus detalhes

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/prices" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Preço Teste\",
    \"details\": [
        {
            \"pre_cost\": \"10.99\",
            \"pre_sale\": \"15.99\",
            \"post_cost\": \"12.99\",
            \"post_sale\": \"17.99\",
            \"product_id\": 1,
            \"production_range_id\": 1
        },
        {
            \"pre_cost\": \"10.99\",
            \"pre_sale\": \"15.99\",
            \"post_cost\": \"12.99\",
            \"post_sale\": \"17.99\",
            \"product_id\": 2,
            \"production_range_id\": 1
        }
    ]
}"
Resposta de exemplo:
{
    "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Calcular Preços dos Produtos

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/prices/calculate
requires authentication

Endpoint para calcular os preços dos produtos informados através do quantidade relacionada a faixa de produção

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/prices/calculate" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"products\": [
        {
            \"product_id\": 1,
            \"quantity\": 21
        }
    ]
}"
Resposta de exemplo:
{
    "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
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Modalidades de Pagamento

Recursos relacionados a gerenciamento de Modalidades de Pagamento da API


Lista Modalidades de Pagamento

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/payment-modalities
requires authentication

Endpoint para listar todos os modalidades de pagamentos

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/payment-modalities" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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"
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Verificar Saldo (Negociação SDeal)

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/payment-modalities/negotiation/check-balance
requires authentication

Endpoint para verificar o saldo da negociação SDeal para modalidade de pagamento

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

registration_number
string
required

CNPJ da Organização

Example:
56539899000170
negotiation
string
required

Negociação SDeal

Example:
160222
type
string
required

Modelo da Negociação SDeal

Must be one of:
  • PRE
  • POS
Example:
PRE
sku
string
required

SKU do Produto

Example:
10
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/payment-modalities/negotiation/check-balance?registration_number=56539899000170&negotiation=160222&type=PRE&sku=10" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "balance": 10
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Métodos de Pagamento

Recursos relacionados a gerenciamento de Métodos de Pagamento da API


Lista métodos de pagamento

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/payment-methods
requires authentication

Endpoint para listar todos os métodos de pagamentos

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/payment-methods" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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"
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Produtos

Recursos relacionados a gerenciamento de Produtos da API


Lista produtos

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/products
requires authentication

Endpoint para listar todos os produtos ativos

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/products" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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"
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Campos Dinâmico

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/products/fields
requires authentication

Endpoint para retornar os campos dinâmicos vindos do SisAR

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

sku
string
required

SKU do produto

Example:
19052
product_id
string
required

ID do produto no SisAR

Example:
147
only_required
boolean

Filtrar somente campos dinâmicos obrigatórios

Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/products/fields?sku=19052&product_id=147" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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
                    }
                ]
            }
        }
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Negociação

Recursos relacionados a gerenciamento de Negociações da API


Listagem de Negociações

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders
requires authentication

Endpoint para listar as Negociações

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

status
string

Status da Negociação

Must be one of:
  • new
  • payment_pending
  • payment_confirmed
  • processing
  • approved_certificate
  • finished
  • canceled
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
                "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": "[email protected]",
                "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": "[email protected]",
                "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": "[email protected]",
                "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Total de Negociações por Status

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/total-per-status
requires authentication

Endpoint para listar Total de Negociações por Status da Organização ou Empresa (Big Numbers)

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

company
string

ULID da Empresa

Example:
01jx03vsk2a58yw82g54cyvgzp
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/total-per-status?company=01jx03vsk2a58yw82g54cyvgzp" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "new": 4,
    "payment_pending": 1,
    "payment_confirmed": 1,
    "processing": 1,
    "approved_certificate": 1,
    "finished": 1,
    "canceled": 1
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Cadastro de Negociação

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders
requires authentication

Endpoint para cadastrar uma Negociação

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"purchase_order\",
    \"payment_modality_id\": 1,
    \"company_id\": 1,
    \"customer_id\": 1,
    \"details\": [
        {
            \"product_id\": 1,
            \"additional_unit_value\": \"2.50\",
            \"quantity\": 1
        }
    ]
}"
Resposta de exemplo:
{
    "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": []
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "",
    "errors": []
}

Mostrar uma Negociação

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/{order_ulid}
requires authentication

Endpoint para mostrar uma Negociação da Organização ou Empresa pelo ULID

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
order_ulid
string
required

ULID da Negociação

Example:
01jx03vfwywqerx836r25qsycz
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/01jx03vfwywqerx836r25qsycz" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
            "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": "[email protected]",
            "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": "[email protected]",
            "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"
            }
        ]
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Remover Negociação

DELETE
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/{order_ulid}
requires authentication

Endpoint para remover uma Negociação

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
order_ulid
string
required

ULID da Negociação

Example:
01jx03qgsgyqcz6qq5a4d8sprc
Requisição de exemplo:
curl --request DELETE \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/01jx03qgsgyqcz6qq5a4d8sprc" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
[Resposta vazia]
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Cancelar Negociação

DELETE
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/{order_ulid}/cancel
requires authentication

Endpoint para cancelar uma negociação

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
order_ulid
string
required

ULID do Pedido

Example:
01jx03pfbaxpd1wmjv0h9srxd4
Requisição de exemplo:
curl --request DELETE \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/01jx03pfbaxpd1wmjv0h9srxd4/cancel" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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"
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}
{
    "message": "Negociação não pode ser cancelada.",
    "errors": {
        "message": [
            "Negociação não pode ser cancelada."
        ]
    }
}
POST
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/{order_ulid}/checkout-link
requires authentication

Endpoint para gerar Checkout Link do Gestão Online

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
order_ulid
string
required

ULID do Pedido

Example:
01jx03pws3mbrnrnry9ry8pyqm
Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/01jx03pws3mbrnrnry9ry8pyqm/checkout-link" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/orders/{order_ulid}/checkout-link
requires authentication

Endpoint para mostrar Checkout Link do Gestão Online

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
order_ulid
string
required

ULID do Pedido

Example:
01jx03pws3mbrnrnry9ry8pyqm
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/orders/01jx03pws3mbrnrnry9ry8pyqm/checkout-link" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:

Reserva

Recursos relacionados a Reserva da API


Total de Reserva por Status

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/stocks/total-per-status
requires authentication

Endpoint para listar Total de Reserva por Status

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

product_sku
int

SKU do Produto

Example:
10
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/stocks/total-per-status?product_sku=10" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "status": {
        "in_stock": 10,
        "reserved": 20
    },
    "total": 30
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Total de Reserva por Produto

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/stocks/total-per-product
requires authentication

Endpoint para listar Total de Reserva por Produto

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

status
string

Status da reserva

Must be one of:
  • in_stock
  • reserved
  • used
Example:
in_stock
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/stocks/total-per-product?status=in_stock" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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
            }
        }
    ]
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Solicitação

Recursos relacionados a buscar de Solicitações da API


Total de Solicitações por Status

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/solicitations/total-per-status
requires authentication

Endpoint para listar Total de Solicitações por Status da Organização (Big Numbers) por CPF/CNPJ

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

registration_number
string
required

CPF/CNPJ da Empresa

Example:
81282527045
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/solicitations/total-per-status?registration_number=81282527045" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "pending": 41,
    "active": 48,
    "inactive": 125,
    "expiring": 5
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Mostrar uma Solicitação

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/solicitations/{code}
requires authentication

Endpoint para mostrar uma Solicitação da Organização por código

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza
code
string
required

Código da Solicitação

Example:
1867240510736592
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/solicitations/1867240510736592" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "solicitation": {
        "code": "186719071053C126",
        "common_name": "FARIA E CAMPOS E FILHOS:23941629000131",
        "cnpj": "23941629000131",
        "owner": "Faria e Campos e Filhos",
        "name": "",
        "cpf": "0",
        "email": "[email protected]",
        "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"
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Listagem de Solicitações

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/organization/{ulid}/solicitations
requires authentication

Endpoint para listar as Solicitações da Organização por CPF/CNPJ

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

ulid
string
required

ULID da Organização

Example:
01jx051j8n539qp7swab85mvza

Parâmetros da Query String

registration_number
string
required

CPF/CNPJ da Empresa

Example:
23941629000131
status
string

Status das solicitações

Must be one of:
  • active
  • inactive
  • pending
  • expiring
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/organization/01jx051j8n539qp7swab85mvza/solicitations?registration_number=23941629000131" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}
{
    "message": "Not Found"
}

Webhook

Recursos relacionados a gerenciamento de Pedidos da API


Cadastro de Pedido

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/webhook/order
requires authentication

Endpoint para cadastrar um Pedido

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
x-spro-authorization
Example:
{AUTHORIZATION_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/webhook/order" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "x-spro-authorization: {AUTHORIZATION_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"FINANCIAL_PAYMENT_DISCHARGE\",
    \"data\": {
        \"id\": 11,
        \"0\": {
            \"id\": 100
        }
    }
}"
Resposta de exemplo:
[]
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Negociação (Emissão Online)

Recursos relacionados a gerenciamento de Negociações da API (Emissão Online)


Listagem de Negociações

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/orders
requires authentication

Endpoint para listar as Negociações

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros da Query String

status
string

Status da Negociação

Must be one of:
  • new
  • payment_pending
  • payment_confirmed
  • processing
  • approved_certificate
  • finished
  • canceled
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/orders" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
                "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": "[email protected]",
                "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": "[email protected]",
                "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": "[email protected]",
                "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Mostrar uma Negociação

GET
https://api-contadores-evd.solutipro.com.br
/api/v1/orders/{order_ulid}
requires authentication

Endpoint para mostrar uma Negociação pelo ULID

Headers

Authorization
Example:
Bearer {AUTHENTICATE_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros de URL

order_ulid
string
required

ULID da Negociação

Example:
01jx03tspz4yzqdb5x9rz6vs0t
Requisição de exemplo:
curl --request GET \
    --get "https://api-contadores-evd.solutipro.com.br/api/v1/orders/01jx03tspz4yzqdb5x9rz6vs0t" \
    --header "Authorization: Bearer {AUTHENTICATE_ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Resposta de exemplo:
{
    "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": "[email protected]",
            "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": "[email protected]",
            "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": "[email protected]",
            "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"
            }
        ]
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}

Organização (Onboarding Digital)

Recursos relacionados a gerenciamento de Organizações da API via Onboarding Digital


Cadastro de Organização

POST
https://api-contadores-evd.solutipro.com.br
/api/v1/onboarding-digital

Endpoint para cadastrar uma Organização via Onboarding Digital

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Parâmetros do Body

Requisição de exemplo:
curl --request POST \
    "https://api-contadores-evd.solutipro.com.br/api/v1/onboarding-digital" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"J\",
    \"registration_number\": \"19640726000117\",
    \"alias\": \"Aguiar e Associados\",
    \"name\": \"Aguiar e Associados\",
    \"phone\": \"(97) 97317-3799\",
    \"whatsapp\": \"(75) 94533-8056\",
    \"email\": \"[email protected]\",
    \"ar_subdomain\": \"arsoluti\",
    \"country_id\": \"181\",
    \"country_name\": \"Brasil\",
    \"state_id\": \"719\",
    \"state_name\": \"GO\",
    \"city_id\": \"281\",
    \"city_name\": \"Goiânia\",
    \"neighborhood\": \"Norte\",
    \"postal_code\": \"70033-161\",
    \"address\": \"Av. Carlos, 609. Bloco A\",
    \"number\": \"784\",
    \"complement\": \"Apto 5\",
    \"price_id\": \"1\",
    \"organization_type_code\": \"accounting\",
    \"products_skus\": [
        10,
        11,
        12
    ],
    \"payment_modalities_code\": [
        \"PAYMENT_ACCOUNTING\",
        \"PAYMENT_CUSTOMER\",
        \"DEBIT_STOCK\",
        \"PRE_PAID_VOUCHER\",
        \"POST_PAID_VOUCHER\"
    ],
    \"recaptcha-token\": \"\",
    \"users\": [
        {
            \"name\": \"Fulano de Tal\",
            \"email\": \"[email protected]\",
            \"registration_number\": \"11122233344\",
            \"phone\": \"(11)99999-9999\",
            \"whatsapp\": \"(11)99999-9999\"
        }
    ]
}"
Resposta de exemplo:
{
    "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": "[email protected]",
        "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
    }
}
{
    "message": "Unauthorized"
}
{
    "message": "Forbidden"
}