Skip to main content
API docs by Redocly

API V3 GuaráCRM (1.0)

Download OpenAPI specification:Download

Api para acesso aos recursos do GuaráCRM

Solicitar sua chave de API através do suporte help@trackmob.com.br

Objeto Doação (donor)

id
integer

Identificador único do doador

name
required
string

Nome do doador

active
boolean

Indica se o doador está ou não ativo

cpf_cnpj
required
string

CPF ou CNPJ do doador

email
required
string

Email do doador

gender_name
string
Enum: "male" "female"

Genero do doador

birth_date
string

Data de nascimento do doador

campaign_id
required
number

Id da campanha relacionada

foreigndonor_id
string

Identificador do registro em um sistema externo

person_responsible
string or null

Pessoa responsável em caso ser pessoa juridica, Obrigatório em caso de pessoa juridica

cellphone
string

Telefone celuar do doador

commercial
string

Telefone comercial do doador

residence
string

Telefone residencial do doador

object or null

Campos customizados do doador, Objeto no formato chave e valor

object

Preferencias de recebimento de comunicação

created_at
string

Data e hora da criação

updated_at
string

Data e hora da ultima alteração

managements_donor_reference
string

ID de referência do doador na plataforma

object (address)
{
  • "id": 1234567890,
  • "name": "Maria de Fátima",
  • "active": true,
  • "cpf_cnpj": "01234567890",
  • "email": "mail@mail.com",
  • "gender_name": "male",
  • "birth_date": "1999-01-01",
  • "campaign_id": 444,
  • "foreigndonor_id": "abc123",
  • "person_responsible": "Jorge Antunes",
  • "cellphone": "5511930650003",
  • "commercial": "552130650003",
  • "residence": "552130650003",
  • "custom_fields": {
    },
  • "preferences": {
    },
  • "created_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "updated_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "managements_donor_reference": "acf9383b-cbef-4210-bce1-b10c8d82328a",
  • "address": {
    }
}

Objeto Doação (donation)

id
integer

Identificador único da doação

donor_id
integer

Identificador único do doador

value
required
number

Valor da doação em reais

frequency
required
string
Enum: "one_shot" "monthly" "bimonthly" "quarterly" "quadrimonthly" "biannual" "annual"

Frequencia de cobrança da doação

status
string
Enum: "actived" "paused" "canceled" "done"

Status da doação Opções:

  • actived: Doação é cobrada normalmente
  • paused: Doação tem suas cobranças pausadas
  • canceled: Doação é cancelada e não é mais cobrada
  • done: Doação está finalizada
type_payment
required
string
Enum: "credit" "debit" "payment_slip" "pix"

Forma de pagamento da doação Opções:

  • credit: Cartão de crédito
  • debit: Débito em conta
  • payment_slip: Boleto Bancário
  • pix: Pix
object

Dados do cartão de crédito Obrigatório em caso de type_payment == credit

object

Dados da conta bancária a ser efetuado o débito Obrigatório em caso de type_payment == debit

payment_day
required
number

Dia do mês em que as cobranças serão realizadas

finished_at
string or null

Data em que a doação foi finalizada

campaign_id
required
number

Id da campanha relacionada

foreigndonation_id
string

Identificador do registro em um sistema externo

object or null

Campos customizados da doação Objeto no formato chave e valor:

created_at
string

Data e hora da criação

updated_at
string

Data e hora da ultima alteração

managements_donation_reference
string

ID de referência da doação na plataforma

{
  • "id": 1234567890,
  • "donor_id": 1234567890,
  • "value": 150.5,
  • "frequency": "monthly",
  • "status": "actived",
  • "type_payment": "credit",
  • "credit_card": {
    },
  • "bank_account": {
    },
  • "payment_day": 10,
  • "finished_at": "2022-01-01",
  • "campaign_id": 444,
  • "foreigndonation_id": "abc123",
  • "custom_fields": {
    },
  • "created_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "updated_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "managements_donation_reference": "acf9383b-cbef-4210-bce1-b10c8d82328a"
}

Objeto Pagamento (payment)

id
integer

Identificador único do pagamento

donor_id
integer

Identificador único do doador

donation_id
integer

Identificador único da doação

processing_date
string

Dia que o pagamento foi efetivado

payment_date
string

Dia de vencimento do pagamento

value
required
number

Valor do pagamento em reais

original_value
number

Valor original do pagamento em reais

payment_status
string
Value: "A"

Status do processamento do pagamento

competence
string

Mês e ano do pagamento

type_payment
required
string

Forma de pagamento da doação Opções:

  • credit: Cartão de crédito
  • debit: Débito em conta
  • payment_slip: Boleto Bancário
  • pix: Pix
return_code
string

Código de retorno do processamento de pagamento

return_message
string

Mensagem de retorno do processamento de pagamento

payment_slip_url
string

URL para visualização do boleto

payment_slip_barcode
string

Código de barra do boleto

pix_qrcode
string

Código pix copia e cola

pix_qrcode_image
string

Imagem com QR do pix

pix_expiration_date
string

Data de expiração do pix

created_at
string

Data e hora da criação

updated_at
string

Data e hora da ultima alteração

managements_charge_reference
string

ID de referência da cobrança na plataforma

{
  • "id": 1234567890,
  • "donor_id": 1234567890,
  • "donation_id": 1234567890,
  • "processing_date": "string",
  • "payment_date": "string",
  • "value": "150.50",
  • "original_value": "150.50",
  • "payment_status": "A",
  • "competence": "02/2022",
  • "type_payment": "credit",
  • "return_code": "string",
  • "return_message": "string",
  • "payment_slip_url": "string",
  • "payment_slip_barcode": "string",
  • "pix_qrcode": "string",
  • "pix_qrcode_image": "string",
  • "pix_expiration_date": "string",
  • "created_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "updated_at": "2022-02-23T16:45:27.634-03:00552130650003",
  • "managements_charge_reference": "acf9383b-cbef-4210-bce1-b10c8d82328a"
}

Buscar doadores

Buscar doadores

Authorizations:
ApiKeyAuth
query Parameters
campaign_id
integer

Filtro pelo campo ID da campanha

updated_at_from
string
Example: updated_at_from=2022-01-01T00:00:00

Filtro no campo updated_at a partir desta data

updated_at_to
string
Example: updated_at_to=2022-01-01T23:59:59

Filtro no campo updated_at até desta data

page
integer
Default: 1
Example: page=1

Usada para listar as próximas pagians da busca

per_page
integer
Default: 100
Example: per_page=100

Usado para definir a quantidade de itens por pagina, máximo 100

name
string

Filtra pelo nome do doador(parcialmente)

email
string

Filtra pelo email do doador

cpf_cnpj
string

Filtra pelo CPF ou CNPJ do doador

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Buscar um doador por ID

Buscar um doador por ID

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Responses

Response samples

Content type
application/json
{
  • "donor": {
    }
}

Atualizar um doador

Atualizar um doador

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Request Body schema: application/json
object (donor)
name
required
string

Nome do doador

cpf_cnpj
required
string

CPF ou CNPJ do doador

email
required
string

Email do doador

gender_name
string
Enum: "male" "female"

Genero do doador

birth_date
string

Data de nascimento do doador

campaign_id
required
number

Id da campanha relacionada

foreigndonor_id
string

Identificador do registro em um sistema externo

person_responsible
string or null

Pessoa responsável em caso ser pessoa juridica, Obrigatório em caso de pessoa juridica

cellphone
string

Telefone celuar do doador

commercial
string

Telefone comercial do doador

residence
string

Telefone residencial do doador

object or null

Campos customizados do doador, Objeto no formato chave e valor

object

Preferencias de recebimento de comunicação

object (address)

Responses

Request samples

Content type
application/json
{
  • "donor": {
    }
}

Response samples

Content type
application/json
{
  • "donor": {
    }
}

Buscar doações

Buscar doações

Authorizations:
ApiKeyAuth
query Parameters
campaign_id
integer

Filtro pelo campo ID da campanha

donor_id
integer

Filtro pleo campo ID do doador

campaign_id
integer

Filtro pelo campo ID da campanha

updated_at_from
string
Example: updated_at_from=2022-01-01T00:00:00

Filtro no campo updated_at a partir desta data

updated_at_to
string
Example: updated_at_to=2022-01-01T23:59:59

Filtro no campo updated_at até desta data

page
integer
Default: 1
Example: page=1

Usada para listar as próximas pagians da busca

per_page
integer
Default: 100
Example: per_page=100

Usado para definir a quantidade de itens por pagina, máximo 100

show_donor
boolean

Indica se retornará nas respostas os dados do doador associado

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Criar doador com doação

Criar doador com doação

Authorizations:
ApiKeyAuth
Request Body schema: application/json
object (donor)
object (donation)

Responses

Request samples

Content type
application/json
{
  • "donor": {
    },
  • "donation": {
    }
}

Response samples

Content type
application/json
{
  • "donor": {
    },
  • "donation": {
    }
}

Criar doador com doação e realizar uma cobrança im

Criar doador com doação e realizar uma cobrança imediata

Authorizations:
ApiKeyAuth
Request Body schema: application/json
object (donor)
object (donation)

Responses

Request samples

Content type
application/json
{
  • "donor": {
    },
  • "donation": {
    }
}

Response samples

Content type
application/json
{
  • "donor": {
    },
  • "donation": {
    },
  • "payment": {
    }
}

Buscar uma doação por ID

Buscar uma doação por ID

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Responses

Response samples

Content type
application/json
{
  • "donation": {
    }
}

Atualizar uma doação

Atualizar uma doação

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Request Body schema: application/json
object (donation)
value
required
number

Valor da doação em reais

frequency
required
string
Enum: "one_shot" "monthly" "bimonthly" "quarterly" "quadrimonthly" "biannual" "annual"

Frequencia de cobrança da doação

status
string
Enum: "actived" "paused" "canceled" "done"

Status da doação Opções:

  • actived: Doação é cobrada normalmente
  • paused: Doação tem suas cobranças pausadas
  • canceled: Doação é cancelada e não é mais cobrada
  • done: Doação está finalizada
type_payment
required
string
Enum: "credit" "debit" "payment_slip" "pix"

Forma de pagamento da doação Opções:

  • credit: Cartão de crédito
  • debit: Débito em conta
  • payment_slip: Boleto Bancário
  • pix: Pix
object

Dados do cartão de crédito Obrigatório em caso de type_payment == credit

object

Dados da conta bancária a ser efetuado o débito Obrigatório em caso de type_payment == debit

payment_day
required
number

Dia do mês em que as cobranças serão realizadas

finished_at
string or null

Data em que a doação foi finalizada

campaign_id
required
number

Id da campanha relacionada

foreigndonation_id
string

Identificador do registro em um sistema externo

object or null

Campos customizados da doação Objeto no formato chave e valor:

Responses

Request samples

Content type
application/json
{
  • "donation": {
    }
}

Response samples

Content type
application/json
{
  • "donation": {
    }
}

Atualizar doação e forçar uma cobrança

Atualizar doação e forçar uma cobrança

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Request Body schema: application/json
object (donation)
value
required
number

Valor da doação em reais

frequency
required
string
Enum: "one_shot" "monthly" "bimonthly" "quarterly" "quadrimonthly" "biannual" "annual"

Frequencia de cobrança da doação

status
string
Enum: "actived" "paused" "canceled" "done"

Status da doação Opções:

  • actived: Doação é cobrada normalmente
  • paused: Doação tem suas cobranças pausadas
  • canceled: Doação é cancelada e não é mais cobrada
  • done: Doação está finalizada
type_payment
required
string
Enum: "credit" "debit" "payment_slip" "pix"

Forma de pagamento da doação Opções:

  • credit: Cartão de crédito
  • debit: Débito em conta
  • payment_slip: Boleto Bancário
  • pix: Pix
object

Dados do cartão de crédito Obrigatório em caso de type_payment == credit

object

Dados da conta bancária a ser efetuado o débito Obrigatório em caso de type_payment == debit

payment_day
required
number

Dia do mês em que as cobranças serão realizadas

finished_at
string or null

Data em que a doação foi finalizada

campaign_id
required
number

Id da campanha relacionada

foreigndonation_id
string

Identificador do registro em um sistema externo

object or null

Campos customizados da doação Objeto no formato chave e valor:

Responses

Request samples

Content type
application/json
{
  • "donation": {
    }
}

Response samples

Content type
application/json
{
  • "donation": {
    },
  • "payment": {
    }
}

Buscar pagamentos

Buscar pagamentos

Authorizations:
ApiKeyAuth
query Parameters
donor_id
integer

Filtro pleo campo ID do doador

donation_id
integer

Filtro pelo campo ID da doação

payment_status
string

Fltro pelo status do pagamento Opções: Pago: payed Boleto ou pix registrados: sent Falha leve: soft_bounce Falha grave: hard_bounce

payment_date
string
Example: payment_date=2022-01-01

Filtro no campo payment_date

processing_date
string
Example: processing_date=2022-01-01

Filtro no campo processing_date

updated_at_from
string
Example: updated_at_from=2022-01-01T00:00:00

Filtro no campo updated_at a partir desta data

updated_at_to
string
Example: updated_at_to=2022-01-01T23:59:59

Filtro no campo updated_at até desta data

page
integer
Default: 1
Example: page=1

Usada para listar as próximas pagians da busca

per_page
integer
Default: 100
Example: per_page=100

Usado para definir a quantidade de itens por pagina, máximo 100

show_donor
boolean

Indica se retornará nas respostas os dados do doador associado

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}

Buscar um pagamento por ID

Buscar um pagamento por ID

Authorizations:
ApiKeyAuth
query Parameters
id
string
Example: id=1

Id do recurso

Responses

Response samples

Content type
application/json
{
  • "payment": {
    }
}