Consultando Produtos e Modalidades de Pagamento

Dados de Cadastro da sua empresa

GET /v1/organization/CLIENT_ID

Este endpoint serve para você pegar os dados de cadastro da sua empresa. Ele lista além dos dados de cadastro, lista também os produtos e modalidades de pagamento associados a ela. Esses dados serão importantes no momento de criar o link de Emissão Online.

circle-info

Todos os endpoints, necessitarão dos 2 tokens no Header e deverá ser passado na URL o CLIENT_ID. Esse assunto foi tratado em Primeiros Passos, caso não tenha este código, acione o time de suporte.

Headers

Name
Value

Content-Type

application/json

Accept

application/json

Authorization

Bearer <token de Autenticação>

x-spro-authorization

<token de Autorização>

Body: Vazio

URL Parameters: exemplo: /v1/organization/CLIENT_ID

Campo
Exemplo de Valor
Descrição

CLIENT_ID

01jawvcvfahk52qsaerzfa0tyj

Código da sua empresa (passado pelo time de integração após o setup). Detalhado em: Primeiros passos.

Response:

Response

{
	"organization": {
		"id": 53,
		"ulid": "01j60cef7q67a1yqszpmrrsdrt",
		"status": true,
		"type": "J",
		"registration_number": "30636660000124",
		"alias": "Nome da sua empresa",
		"name": "Nome da sua empresa",
		"ulid_ar": "01j0trb4mqf2g7rxewbqaxxj8f",
		"ar_subdomain": "arsoluti",
		"email": "contato@suaempresa.com.br",
		"phone": "(17) 99856-3853",
		"whatsapp": "",
		"country_id": 181,
		"state_id": 719,
		"city_id": 5201405,
		"address": "Rua Teste",
		"number": null,
		"complement": null,
		"neighborhood": "Setor X",
		"postal_code": "00000-000",
		"products": [
			{
				"id": 2,
				"certificate_type": "A1",
				"person_type": "PJ",
				"name": "Certificado PJ A1 - Spro Contadores",
				"validate": 1,
				"description": "ACS PJ A1 V5 G2 - SPRO CONTADORES"
			}
		],
		"payment_modalities": [
			{
				"id": 4,
				"name": "Utilizar voucher pré-pago",
				"code": "PRE_PAID_VOUCHER"
			},
			{
				"id": 5,
				"name": "Utilizar voucher pós-pago",
				"code": "POST_PAID_VOUCHER"
			}
		]
	}
}	

Campos importantes:

Grupo
Campo
Descrição

organization

Dados de cadastro da sua empresa

ulid

Este é o código da sua empresa (CLIENT_ID)

products

Lista dos produtos associados a sua empresa

id

Identificação do Produto (você precisará dele para criar o link para o Emissão Online)

name

Nome do produto

payment_modalities

Modalidades de pagamento associadas a sua empresa

id

Identificação da modalidade de pagamento (você precisará dele para criar o link para o Emissão Online)

name

Nome da modalidade de pagamento

code

Código da modalidade de pagamento

Last updated