{ "openapi": "3.1.0", "info": { "title": "Quyta", "description": "Esta documentação detalha os endpoints disponíveis na API REST da Quyta. Através do console é possível gerar automaticamente o código das requisições para diversas linguagens (PHP, Java, Ruby, entre muitas outras).\n\nA comunicação é feita a partir do endereço base https://app.quyta.com.br/api, utilizando sempre o protocolo seguro https://.\n\n ### 🚨 Atenção!\n > Antes de continuar, certifique-se de que as configurações de autenticação estão corretas. Caso tenha dúvidas sobre essa etapa, clique [aqui](/autenticacao) e siga as orientações.", "version": "1.0.0", "contact": { "name": "Suporte Quyta", "email": "suporte@quyta.com.br" } }, "servers": [ { "url": "https://app.quyta.com.br/api/v1", "description": "Servidor de Produção" } ], "security": [ { "BearerToken": [] } ], "components": { "securitySchemes": { "BearerToken": { "type": "http", "scheme": "bearer", "description": "Token de autenticação da API. Formato: Bearer {token}." } }, "responses": { "Unauthorized": { "description": "Não autorizado - Token não fornecido, não encontrado, expirado ou revogado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "NotFound": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "UnprocessableEntity": { "description": "Dados inválidos na requisição", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "The given data was invalid.", "description": "Mensagem de erro legivel." }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "due_date": [ "The due date field is required." ] }, "description": "Valor do campo errors." } } } } } } }, "schemas": { "Customer": { "type": "object", "properties": { "id": { "type": "integer", "description": "Identificador unico do cliente.", "example": 1 }, "business_unit_id": { "type": "integer", "description": "ID da unidade de negocio do cliente.", "example": 1 }, "name": { "type": "string", "description": "Nome completo do cliente.", "example": "John Doe" }, "document": { "type": "string", "description": "Documento do cliente (CPF/CNPJ).", "example": "12345678909" }, "person_type": { "type": "string", "enum": [ "F", "J" ], "description": "Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).", "example": "F" }, "emails": { "type": "array", "items": { "type": "object" }, "description": "Lista de emails do cliente.", "example": [ { "id": 1, "email": "john.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "description": "Lista de telefones do cliente.", "example": [ { "id": 1, "phone": "+5511999999999" } ] }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora de criacao do cliente." }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da ultima atualizacao do cliente." } } }, "Debt": { "type": "object", "properties": { "id": { "type": "integer", "description": "Identificador unico da divida.", "example": 1 }, "customer_id": { "type": "integer", "description": "ID do cliente associado a divida.", "example": 1 }, "debt_group_id": { "type": "integer", "description": "ID do grupo de divida associado.", "example": 1 }, "business_unit_id": { "type": "integer", "description": "ID da unidade de negocio da divida.", "example": 1 }, "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)", "example": "PENDING" }, "is_collectable": { "type": "boolean", "description": "Indica se a divida esta apta para cobranca.", "example": true }, "is_contractable": { "type": "boolean", "description": "Indica se a divida pode ser incluida em acordo.", "example": true }, "original_value": { "type": "number", "format": "decimal", "description": "Valor original da divida.", "example": 1000 }, "today_value": { "type": "number", "format": "decimal", "description": "Valor atualizado da divida na data atual.", "example": 1100 }, "due_date": { "type": "string", "format": "date", "description": "Data de vencimento da divida.", "example": "2024-01-15" }, "origin_date": { "type": "string", "format": "date", "description": "Data de origem da divida.", "example": "2024-01-15" }, "external_id": { "type": "string", "description": "Identificador externo da divida no sistema de origem.", "example": "EXT123" }, "origin_contract_id": { "type": "string", "nullable": true, "description": "Codigo do contrato ou acordo original no sistema de origem.", "example": "767" }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora de criacao da divida." }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da ultima atualizacao da divida." } } }, "DebtGroup": { "type": "object", "properties": { "id": { "type": "integer", "description": "Identificador unico do grupo de divida.", "example": 1 }, "business_unit_id": { "type": "integer", "description": "ID da unidade de negocio do grupo de divida.", "example": 1 }, "name": { "type": "string", "description": "Nome do grupo de divida.", "example": "Grupo de Dívida A" }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora de criacao do grupo de divida." }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da ultima atualizacao do grupo de divida." } } }, "RevokedTokenError": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem de erro legivel.", "example": "Token revogado" }, "error_code": { "type": "string", "description": "Codigo interno do erro.", "example": "API_AUT_04" }, "status_code": { "type": "integer", "description": "Codigo HTTP do erro.", "example": 401 } } }, "ExpiredTokenError": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem de erro legivel.", "example": "Token expirado" }, "error_code": { "type": "string", "description": "Codigo interno do erro.", "example": "API_AUT_03" }, "status_code": { "type": "integer", "description": "Codigo HTTP do erro.", "example": 401 } } }, "AuthError": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem de erro legivel.", "example": "Token não encontrado" }, "error_code": { "type": "string", "description": "Codigo interno do erro.", "example": "API_AUT_02" }, "status_code": { "type": "integer", "description": "Codigo HTTP do erro.", "example": 401 } }, "examples": { "token_not_found": { "summary": "Token não encontrado", "value": { "message": "Token não encontrado", "error_code": "API_AUT_02", "status_code": 401 } }, "token_expired": { "summary": "Token expirado", "value": { "message": "Token expirado", "error_code": "API_AUT_03", "status_code": 401 } }, "token_revoked": { "summary": "Token revogado", "value": { "message": "Token revogado", "error_code": "API_AUT_04", "status_code": 401 } }, "insufficient_permission": { "summary": "Permissão insuficiente", "value": { "message": "Acesso negado: permissão insuficiente.", "error_code": "API_AUT_05", "status_code": 403 } } } }, "NotFoundError": { "type": "object", "properties": { "message": { "type": "string", "description": "Mensagem de erro legivel.", "example": "Recurso não encontrado" }, "error_code": { "type": "string", "description": "Codigo interno do erro.", "example": "NTF_001" }, "status_code": { "type": "integer", "description": "Codigo HTTP do erro.", "example": 404 } } }, "WebhookEvent": { "type": "object", "description": "Estrutura base de todos os eventos de webhook", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID único do evento", "example": "550e8400-e29b-41d4-a716-446655440000" }, "type": { "type": "string", "description": "Tipo do evento", "example": "debt.created" }, "version": { "type": "string", "description": "Versão do formato do evento", "example": "1" }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora do evento em ISO 8601", "example": "2024-01-15T10:30:00Z" }, "data": { "type": "object", "description": "Dados específicos do evento" } }, "required": [ "id", "type", "version", "created_at", "data" ] }, "WebhookEventDebtCreated": { "type": "object", "description": "Evento disparado quando uma dívida é criada no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEvent" }, { "type": "object", "properties": { "type": { "type": "string", "example": "debt.created", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "description": { "type": "string", "example": "Parcela vencida", "description": "Descricao do item." }, "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)" }, "original_value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor original." }, "today_value": { "type": "number", "format": "decimal", "example": 1100, "description": "Valor atualizado." }, "due_date": { "type": "string", "format": "date-time", "description": "Data de vencimento em formato ISO 8601", "example": "2024-01-15T10:30:00.000000Z" }, "origin_date": { "type": "string", "format": "date", "description": "Data de origem em formato Y-m-d", "example": "2024-01-01" }, "external_id": { "type": "string", "nullable": true, "example": "EXT123", "description": "Identificador externo da divida no sistema de origem." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora de criacao." }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da ultima atualizacao." } }, "description": "Dados da divida." }, "customer": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "John Doe", "description": "Nome do registro." }, "document": { "type": "string", "example": "12345678909", "description": "Documento (CPF/CNPJ)." }, "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" } ], "description": "Lista de emails." }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5511999999999" } ], "description": "Lista de telefones." } }, "description": "Dados do cliente." }, "debt_group": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "Grupo de Dívida A", "description": "Nome do registro." } }, "description": "Dados do grupo de divida." }, "business_unit": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "Empresa Exemplo", "description": "Nome do registro." } }, "description": "Dados da unidade de negocio." } }, "description": "Dados do item." } } } ] }, "WebhookEventDebtHeld": { "type": "object", "description": "Evento disparado quando a cobrança de uma dívida é pausada no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventDebtCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "debt.held", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)", "example": "ON_HOLD" } }, "description": "Dados da divida." } }, "description": "Dados do item." } } } ] }, "WebhookEventDebtArchived": { "type": "object", "description": "Evento disparado quando uma dívida é arquivada no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventDebtCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "debt.archived", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)", "example": "ARCHIVED" } }, "description": "Dados da divida." } }, "description": "Dados do item." } } } ] }, "WebhookEventDebtUnarchived": { "type": "object", "description": "Evento disparado quando uma dívida é desarquivada no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventDebtCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "debt.unarchived", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)", "example": "ON_HOLD" } }, "description": "Dados da divida." } }, "description": "Dados do item." } } } ] }, "WebhookEventDebtReactivated": { "type": "object", "description": "Evento disparado quando a cobrança de uma dívida é reativada no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventDebtCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "debt.reactivated", "description": "Tipo do item." } } } ] }, "WebhookEventCustomerCreated": { "type": "object", "description": "Evento disparado quando um novo cliente é criado no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEvent" }, { "type": "object", "properties": { "type": { "type": "string", "example": "customer.created", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "John Doe", "description": "Nome do registro." }, "document": { "type": "string", "example": "12345678909", "description": "Documento (CPF/CNPJ)." }, "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ], "description": "Lista de emails." }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ], "description": "Lista de telefones." } }, "description": "Dados do cliente." }, "business_unit": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "Empresa Exemplo", "description": "Nome do registro." } }, "description": "Dados da unidade de negocio." } }, "description": "Dados do item." } } } ] }, "WebhookEventContractCreated": { "type": "object", "description": "Evento disparado quando um novo acordo é criado no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEvent" }, { "type": "object", "properties": { "type": { "type": "string", "example": "contract.created", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "description": { "type": "string", "example": "Acordo de negociação", "description": "Descricao do item." }, "status": { "type": "string", "enum": [ "ACTIVE", "DEBT_CONFESSION_PENDING", "OVERDUE", "TERMINATED", "SETTLED" ], "description": "Status do acordo. Valores possíveis: ACTIVE (Ativo - acordo em andamento), DEBT_CONFESSION_PENDING (Confissão Pendente - aguardando assinatura da confissão de dívida), OVERDUE (Atrasado - acordo com parcelas em atraso), TERMINATED (Quebrado - acordo cancelado), SETTLED (Liquidado - todas as parcelas foram pagas)", "example": "ACTIVE" }, "value": { "type": "number", "format": "decimal", "example": 5000, "description": "Valor monetario." }, "discount": { "type": "number", "format": "decimal", "example": 500, "description": "Valor de desconto." }, "created_at": { "type": "string", "format": "date-time", "description": "Data e hora de criacao." }, "updated_at": { "type": "string", "format": "date-time", "description": "Data e hora da ultima atualizacao." } }, "description": "Dados do acordo." }, "installments": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor monetario." }, "status": { "type": "string", "enum": [ "PENDING", "PAID", "OVERDUE", "SETTLED", "CANCELLED" ], "description": "Status da parcela. Valores possíveis: PENDING (Pendente - parcela aguardando pagamento), PAID (Pago - parcela foi paga), OVERDUE (Atrasado - parcela vencida e não paga), SETTLED (Liquidado - parcela liquidada), CANCELLED (Cancelado - parcela cancelada)" }, "due_date": { "type": "string", "format": "date-time", "description": "Data de vencimento da parcela em formato ISO 8601", "example": "2024-02-15T10:30:00.000000Z" } } }, "description": "Lista de parcelas." }, "debts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "description": { "type": "string", "example": "Parcela vencida", "description": "Descricao do item." }, "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)" }, "original_value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor original." }, "today_value": { "type": "number", "format": "decimal", "example": 1100, "description": "Valor atualizado." }, "due_date": { "type": "string", "format": "date-time", "description": "Data de vencimento em formato ISO 8601", "example": "2024-01-15T10:30:00.000000Z" }, "origin_date": { "type": "string", "format": "date", "description": "Data de origem em formato Y-m-d", "example": "2024-01-01" }, "external_id": { "type": "string", "nullable": true, "example": "EXT123", "description": "Identificador externo da divida no sistema de origem." } } }, "description": "Lista de dividas." }, "customer": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "John Doe", "description": "Nome do registro." }, "document": { "type": "string", "example": "12345678909", "description": "Documento (CPF/CNPJ)." }, "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ], "description": "Lista de emails." }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ], "description": "Lista de telefones." } }, "description": "Dados do cliente." }, "business_unit": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "name": { "type": "string", "example": "Empresa Exemplo", "description": "Nome do registro." } }, "description": "Dados da unidade de negocio." } }, "description": "Dados do item." } } } ] }, "WebhookEventContractTerminated": { "type": "object", "description": "Evento disparado quando um acordo é quebrado no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventContractCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "contract.terminated", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "DEBT_CONFESSION_PENDING", "OVERDUE", "TERMINATED", "SETTLED" ], "description": "Status do acordo. Valores possíveis: ACTIVE (Ativo - acordo em andamento), DEBT_CONFESSION_PENDING (Confissão Pendente - aguardando assinatura da confissão de dívida), OVERDUE (Atrasado - acordo com parcelas em atraso), TERMINATED (Quebrado - acordo cancelado), SETTLED (Liquidado - todas as parcelas foram pagas)", "example": "TERMINATED" } }, "description": "Dados do acordo." } }, "description": "Dados do item." } } } ] }, "WebhookEventContractSettled": { "type": "object", "description": "Evento disparado quando um acordo é liquidado no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventContractCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "contract.settled", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "DEBT_CONFESSION_PENDING", "OVERDUE", "TERMINATED", "SETTLED" ], "description": "Status do acordo. Valores possíveis: ACTIVE (Ativo - acordo em andamento), DEBT_CONFESSION_PENDING (Confissão Pendente - aguardando assinatura da confissão de dívida), OVERDUE (Atrasado - acordo com parcelas em atraso), TERMINATED (Quebrado - acordo cancelado), SETTLED (Liquidado - todas as parcelas foram pagas)", "example": "SETTLED" } }, "description": "Dados do acordo." }, "installments": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "PAID", "OVERDUE", "SETTLED", "CANCELLED" ], "description": "Status da parcela. Valores possíveis: PENDING (Pendente - parcela aguardando pagamento), PAID (Pago - parcela foi paga), OVERDUE (Atrasado - parcela vencida e não paga), SETTLED (Liquidado - parcela liquidada), CANCELLED (Cancelado - parcela cancelada)", "example": "PAID" } } }, "description": "Lista de parcelas." }, "debts": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ], "description": "Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)", "example": "SETTLED" } } }, "description": "Lista de dividas." } }, "description": "Dados do item." } } } ] }, "WebhookEventContractInstallmentPaid": { "type": "object", "description": "Evento disparado quando uma parcela de um acordo é paga no sistema.", "allOf": [ { "$ref": "#/components/schemas/WebhookEventContractCreated" }, { "type": "object", "properties": { "type": { "type": "string", "example": "contract.installment.paid", "description": "Tipo do item." }, "data": { "type": "object", "properties": { "installment_paid": { "type": "object", "description": "Informações da parcela que foi paga", "properties": { "id": { "type": "integer", "example": 1, "description": "Identificador unico do registro." }, "value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor monetario." }, "status": { "type": "string", "enum": [ "PENDING", "PAID", "OVERDUE", "SETTLED", "CANCELLED" ], "description": "Status da parcela. Valores possíveis: PENDING (Pendente - parcela aguardando pagamento), PAID (Pago - parcela foi paga), OVERDUE (Atrasado - parcela vencida e não paga), SETTLED (Liquidado - parcela liquidada), CANCELLED (Cancelado - parcela cancelada)", "example": "PAID" }, "due_date": { "type": "string", "format": "date-time", "description": "Data de vencimento da parcela em formato ISO 8601", "example": "2024-02-15T10:30:00.000000Z" }, "paid_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Data e hora do pagamento da parcela em formato ISO 8601", "example": "2024-02-15T10:30:00.000000Z" } } } }, "description": "Dados do item." } } } ] } }, "examples": { "WebhookDebtCreated": { "summary": "Exemplo de webhook: debt.created", "value": { "id": "550e8400-e29b-41d4-a716-446655440000", "type": "debt.created", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "debt": { "id": 1, "description": "Parcela vencida", "status": "PENDING", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "debt_group": { "id": 1, "name": "Grupo de Dívida A" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookDebtHeld": { "summary": "Exemplo de webhook: debt.held", "value": { "id": "550e8400-e29b-41d4-a716-446655440001", "type": "debt.held", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "debt": { "id": 1, "description": "Parcela vencida", "status": "ON_HOLD", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "customer": { "id": 1, "name": "John Doe", "document": "12345678909" }, "debt_group": { "id": 1, "name": "Grupo de Dívida A" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookDebtArchived": { "summary": "Exemplo de webhook: debt.archived", "value": { "id": "550e8400-e29b-41d4-a716-446655440003", "type": "debt.archived", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "debt": { "id": 1, "description": "Parcela vencida", "status": "ARCHIVED", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "debt_group": { "id": 1, "name": "Grupo de Dívida A" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookDebtUnarchived": { "summary": "Exemplo de webhook: debt.unarchived", "value": { "id": "550e8400-e29b-41d4-a716-446655440004", "type": "debt.unarchived", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "debt": { "id": 1, "description": "Parcela vencida", "status": "ON_HOLD", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "debt_group": { "id": 1, "name": "Grupo de Dívida A" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookDebtReactivated": { "summary": "Exemplo de webhook: debt.reactivated", "value": { "id": "550e8400-e29b-41d4-a716-446655440002", "type": "debt.reactivated", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "debt": { "id": 1, "description": "Parcela vencida", "status": "PENDING", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "customer": { "id": 1, "name": "John Doe", "document": "12345678909" }, "debt_group": { "id": 1, "name": "Grupo de Dívida A" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookCustomerCreated": { "summary": "Exemplo de webhook: customer.created", "value": { "id": "550e8400-e29b-41d4-a716-446655440000", "type": "customer.created", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookContractCreated": { "summary": "Exemplo de webhook: contract.created", "value": { "id": "550e8400-e29b-41d4-a716-446655440000", "type": "contract.created", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "contract": { "id": 1, "description": "Acordo de negociação", "status": "ACTIVE", "value": 5000, "discount": 500, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "installments": [ { "value": 1000, "status": "PENDING", "due_date": "2024-02-15T10:30:00.000000Z" }, { "value": 1000, "status": "PENDING", "due_date": "2024-03-15T10:30:00.000000Z" } ], "debts": [ { "id": 1, "description": "Parcela vencida", "status": "PENDING", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123" } ], "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookContractTerminated": { "summary": "Exemplo de webhook: contract.terminated", "value": { "id": "550e8400-e29b-41d4-a716-446655440003", "type": "contract.terminated", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "contract": { "id": 1, "description": "Acordo de negociação", "status": "TERMINATED", "value": 5000, "discount": 500, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "installments": [ { "value": 1000, "status": "PENDING", "due_date": "2024-02-15T10:30:00.000000Z" }, { "value": 1000, "status": "PENDING", "due_date": "2024-03-15T10:30:00.000000Z" } ], "debts": [ { "id": 1, "description": "Parcela vencida", "status": "PENDING", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123" } ], "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookContractSettled": { "summary": "Exemplo de webhook: contract.settled", "value": { "id": "550e8400-e29b-41d4-a716-446655440004", "type": "contract.settled", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "contract": { "id": 1, "description": "Acordo de negociação", "status": "SETTLED", "value": 5000, "discount": 500, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "installments": [ { "value": 1000, "status": "PAID", "due_date": "2024-02-15T10:30:00.000000Z" }, { "value": 1000, "status": "PAID", "due_date": "2024-03-15T10:30:00.000000Z" } ], "debts": [ { "id": 1, "description": "Parcela vencida", "status": "SETTLED", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123" } ], "customer": { "id": 1, "name": "John Doe", "document": "12345678909", "emails": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "email": "john.doe@domain.com" }, { "id": 2, "email": "mary.doe@domain.com" } ] }, "phones": { "type": "array", "items": { "type": "object" }, "example": [ { "id": 1, "phone": "+5585999999999" }, { "id": 2, "phone": "+5585999999999" } ] } }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } }, "WebhookContractInstallmentPaid": { "summary": "Exemplo de webhook: contract.installment.paid", "value": { "id": "550e8400-e29b-41d4-a716-446655440005", "type": "contract.installment.paid", "version": "1", "created_at": "2024-01-15T10:30:00Z", "data": { "contract": { "id": 1, "description": "Acordo de negociação", "status": "ACTIVE", "value": 5000, "discount": 500, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" }, "installment_paid": { "id": 1, "value": 1000, "status": "PAID", "due_date": "2024-02-15T10:30:00.000000Z", "paid_at": "2024-02-15T10:30:00.000000Z" }, "installments": [ { "value": 1000, "status": "PAID", "due_date": "2024-02-15T10:30:00.000000Z" }, { "value": 1000, "status": "PENDING", "due_date": "2024-03-15T10:30:00.000000Z" } ], "debts": [ { "id": 1, "description": "Parcela vencida", "status": "PENDING", "original_value": 1000, "today_value": 1100, "due_date": "2024-01-15T10:30:00.000000Z", "origin_date": "2024-01-01", "external_id": "EXT123" } ], "customer": { "id": 1, "name": "John Doe", "document": "12345678909" }, "business_unit": { "id": 1, "name": "Empresa Exemplo" } } } } } }, "paths": { "/customers": { "get": { "summary": "Listar clientes", "description": "Retorna uma lista paginada de clientes.", "tags": [ "Clientes" ], "parameters": [ { "name": "document", "in": "query", "description": "Filtrar por documento", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da página", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Número de itens por página", "required": false, "schema": { "type": "integer", "default": 15 } } ], "responses": { "200": { "description": "Lista de clientes", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "description": "Dados do item." }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total de registros disponiveis." }, "per_page": { "type": "integer", "description": "Quantidade de itens por pagina." }, "current_page": { "type": "integer", "description": "Pagina atual." }, "total_pages": { "type": "integer", "description": "Total de paginas." } }, "description": "Metadados da paginacao." } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } }, "post": { "summary": "Criar cliente", "description": "Cria um novo cliente", "tags": [ "Clientes" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "document", "addr_zipcode", "addr_street", "addr_number", "addr_district", "addr_city", "addr_state", "emails", "phones" ], "properties": { "name": { "type": "string", "maxLength": 255, "example": "John Doe", "description": "Nome do registro." }, "document": { "type": "string", "example": "12345678909", "description": "Documento (CPF/CNPJ)." }, "addr_zipcode": { "type": "string", "pattern": "^[0-9]{8}$", "example": "01234567", "description": "CEP do endereco." }, "addr_street": { "type": "string", "maxLength": 255, "example": "Rua do John Doe", "description": "Logradouro do endereco." }, "addr_number": { "type": "string", "maxLength": 20, "example": "123", "description": "Numero do endereco." }, "addr_district": { "type": "string", "maxLength": 255, "example": "Centro", "description": "Bairro do endereco." }, "addr_city": { "type": "string", "maxLength": 255, "example": "São Paulo", "description": "Cidade do endereco." }, "addr_state": { "type": "string", "maxLength": 255, "example": "SP", "description": "Estado do endereco." }, "addr_extra": { "type": "string", "maxLength": 255, "example": "Apto 45", "description": "Complemento do endereco." }, "emails": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "email" }, "example": [ "john.doe@domain.com", "mary.doe@domain.com" ], "description": "Lista de emails." }, "phones": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 }, "example": [ "+5511999999999", "+5511988888888" ], "description": "Lista de telefones." } } } } } }, "responses": { "201": { "description": "Cliente criado com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/customers/{id}": { "get": { "summary": "Obter cliente", "description": "Retorna os detalhes de um cliente específico", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do cliente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "summary": "Atualizar cliente", "description": "Atualiza os dados de um cliente existente", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "addr_zipcode", "addr_street", "addr_number", "addr_district", "addr_city", "addr_state" ], "properties": { "name": { "type": "string", "maxLength": 255, "example": "John Doe", "description": "Nome do registro." }, "addr_zipcode": { "type": "string", "pattern": "^[0-9]{8}$", "example": "01234567", "description": "CEP do endereco." }, "addr_street": { "type": "string", "maxLength": 255, "example": "Rua do John Doe", "description": "Logradouro do endereco." }, "addr_number": { "type": "string", "maxLength": 20, "example": "123", "description": "Numero do endereco." }, "addr_district": { "type": "string", "maxLength": 255, "example": "Centro", "description": "Bairro do endereco." }, "addr_city": { "type": "string", "maxLength": 255, "example": "São Paulo", "description": "Cidade do endereco." }, "addr_state": { "type": "string", "maxLength": 255, "example": "SP", "description": "Estado do endereco." }, "addr_extra": { "type": "string", "maxLength": 255, "example": "Apto 45", "description": "Complemento do endereco." } } } } } }, "responses": { "200": { "description": "Cliente atualizado com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "description": "Dados inválidos" } } } }, "/customers/{id}/phones": { "post": { "summary": "Adicionar telefones ao cliente", "description": "Adiciona um ou mais telefones ao cliente", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "phones" ], "properties": { "phones": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 }, "example": [ "+5511999999999", "+5511988888888" ], "description": "Lista de telefones." } } } } } }, "responses": { "201": { "description": "Telefones adicionados com sucesso" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "description": "Dados inválidos" } } } }, "/customers/{id}/phones/{phoneId}": { "delete": { "summary": "Remover telefone do cliente", "description": "Remove um telefone de um cliente", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } }, { "name": "phoneId", "in": "path", "required": true, "description": "ID do telefone", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Telefone removido com sucesso" }, "400": { "description": "Requisição inválida" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/customers/{id}/emails": { "post": { "summary": "Adicionar emails ao cliente", "description": "Adiciona um ou mais emails ao cliente", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "emails" ], "properties": { "emails": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "email" }, "example": [ "john.doe@domain.com", "mary.doe@domain.com" ], "description": "Lista de emails." } } } } } }, "responses": { "201": { "description": "Emails adicionados com sucesso" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "description": "Dados inválidos" } } } }, "/customers/{id}/emails/{emailId}": { "delete": { "summary": "Remover email do cliente", "description": "Remove um email de um cliente", "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do cliente", "schema": { "type": "integer" } }, { "name": "emailId", "in": "path", "required": true, "description": "ID do email", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Email removido com sucesso" }, "400": { "description": "Requisição inválida" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/debts": { "get": { "summary": "Listar dívidas", "description": "Retorna uma lista paginada de dívidas.", "tags": [ "Dívidas" ], "parameters": [ { "name": "is_collectable", "in": "query", "description": "Filtrar por dívidas coletáveis", "required": false, "schema": { "type": "boolean" } }, { "name": "is_contractable", "in": "query", "description": "Filtrar por dívidas contratáveis", "required": false, "schema": { "type": "boolean" } }, { "name": "customer_id", "in": "query", "description": "Filtrar por cliente", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Filtrar por status", "required": false, "schema": { "type": "string", "enum": [ "PENDING", "SETTLED", "ON_HOLD", "ARCHIVED", "UNDER_CONTRACT" ] } }, { "name": "document", "in": "query", "description": "Filtrar por documento do cliente", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "Filtrar por external_id", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Número da página", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Número de itens por página", "required": false, "schema": { "type": "integer", "default": 15 } } ], "responses": { "200": { "description": "Lista de dívidas", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Debt" }, "description": "Dados do item." }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total de registros disponiveis." }, "per_page": { "type": "integer", "description": "Quantidade de itens por pagina." }, "current_page": { "type": "integer", "description": "Pagina atual." }, "total_pages": { "type": "integer", "description": "Total de paginas." } }, "description": "Metadados da paginacao." } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } }, "post": { "summary": "Criar dívida", "description": "Cria uma nova dívida", "tags": [ "Dívidas" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "customer_id", "debt_group_id", "original_value", "due_date", "description" ], "properties": { "customer_id": { "type": "integer", "example": 1, "description": "ID do cliente associado." }, "debt_group_id": { "type": "integer", "example": 1, "description": "ID do grupo de divida associado." }, "original_value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor original." }, "due_date": { "type": "string", "format": "date", "example": "2024-01-15", "description": "Data de vencimento." }, "description": { "type": "string", "maxLength": 255, "example": "Parcela vencida", "description": "Descricao do item." }, "external_id": { "type": "string", "maxLength": 255, "example": "EXT123", "description": "Identificador externo da divida no sistema de origem." }, "origin_contract_id": { "type": "string", "maxLength": 255, "nullable": true, "example": "767", "description": "Codigo do contrato ou acordo original no sistema de origem." }, "origin_date": { "type": "string", "format": "date", "example": "2024-01-15", "description": "Data de origem." } } } } } }, "responses": { "201": { "description": "Dívida criada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Debt" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/debts/{id}": { "get": { "summary": "Obter dívida", "description": "Retorna os detalhes de uma dívida específica", "tags": [ "Dívidas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID da dívida", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes da dívida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Debt" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "summary": "Atualizar dívida", "description": "Atualiza os dados de uma dívida existente. Apenas dívidas com status `PENDING`, `ON_HOLD` ou `ARCHIVED` podem ser atualizadas.", "tags": [ "Dívidas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID da dívida", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "debt_group_id": { "type": "integer", "example": 1, "description": "ID do grupo de divida associado." }, "original_value": { "type": "number", "format": "decimal", "example": 1000, "description": "Valor original." }, "due_date": { "type": "string", "format": "date", "example": "2024-01-15", "description": "Data de vencimento." }, "description": { "type": "string", "maxLength": 255, "example": "Parcela vencida", "description": "Descricao do item." }, "external_id": { "type": "string", "maxLength": 255, "nullable": true, "example": "EXT123", "description": "Identificador externo da divida no sistema de origem." }, "origin_date": { "type": "string", "format": "date", "nullable": true, "example": "2024-01-15", "description": "Data de origem." } } } } } }, "responses": { "200": { "description": "Dívida atualizada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Debt" } } } }, "400": { "description": "Dívida não pode ser editada (status incompatível)", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Apenas dívidas pendentes, em dia ou pausadas podem ser editadas", "description": "Mensagem de erro legivel." }, "error_code": { "type": "string", "example": "DBT_003", "description": "Codigo interno do erro." } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } } } }, "/debtgroups": { "get": { "summary": "Listar grupos de dívidas", "description": "Retorna uma lista paginada de grupos de dívidas", "tags": [ "Grupos de Dívidas" ], "parameters": [ { "name": "page", "in": "query", "description": "Número da página", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Número de itens por página", "required": false, "schema": { "type": "integer", "default": 15 } } ], "responses": { "200": { "description": "Lista de grupos de dívidas", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DebtGroup" }, "description": "Dados do item." }, "meta": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total de registros disponiveis." }, "per_page": { "type": "integer", "description": "Quantidade de itens por pagina." }, "current_page": { "type": "integer", "description": "Pagina atual." }, "total_pages": { "type": "integer", "description": "Total de paginas." } }, "description": "Metadados da paginacao." } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" } } } }, "/debtgroups/{id}": { "get": { "summary": "Obter grupo de dívida", "description": "Retorna os detalhes de um grupo de dívida específico", "tags": [ "Grupos de Dívidas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID do grupo de dívida", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do grupo de dívida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebtGroup" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } } }, "webhooks": { "debt.created": { "post": { "operationId": "webhookDebtCreated", "summary": "Dívida Criada", "description": "Este webhook é disparado quando uma nova dívida é criada no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "description": "Payload do evento de dívida criada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDebtCreated" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "debt.held": { "post": { "operationId": "webhookDebtHeld", "summary": "Cobrança Pausada", "description": "Este webhook é disparado quando a cobrança de uma dívida é pausada no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDebtHeld" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "debt.reactivated": { "post": { "operationId": "webhookDebtReactivated", "summary": "Cobrança Reativada", "description": "Este webhook é disparado quando a cobrança de uma dívida é reativada no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDebtReactivated" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "debt.archived": { "post": { "operationId": "webhookDebtArchived", "summary": "Dívida Arquivada", "description": "Este webhook é disparado quando uma dívida é arquivada no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDebtArchived" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "debt.unarchived": { "post": { "0": "**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "operationId": "webhookDebtUnarchived", "summary": "Dívida Desarquivada", "description": "Evento disparado quando uma dívida é desarquivada no sistema. Ao desarquivar, o status da dívida volta para o status de pendente (PENDING).", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventDebtUnarchived" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "customer.created": { "post": { "operationId": "webhookCustomerCreated", "summary": "Cliente Criado", "description": "Este webhook é disparado quando um novo cliente é criado no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventCustomerCreated" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "contract.created": { "post": { "operationId": "webhookContractCreated", "summary": "Acordo Criado", "description": "Este webhook é disparado quando um novo acordo é criado no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventContractCreated" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "contract.terminated": { "post": { "operationId": "webhookContractTerminated", "summary": "Acordo Quebrado", "description": "Este webhook é disparado quando um acordo é quebrado no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventContractTerminated" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "contract.settled": { "post": { "operationId": "webhookContractSettled", "summary": "Acordo Liquidado", "description": "Este webhook é disparado quando um acordo é liquidado, onde todas as parcelas do acordo foram pagas.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventContractSettled" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } }, "contract.installment.paid": { "post": { "operationId": "webhookContractInstallmentPaid", "summary": "Parcela Paga", "description": "Este webhook é disparado quando uma parcela de um acordo é paga no sistema.\n\n**Importante:** A entrega será considerada bem-sucedida apenas se a URL retornar um código de status HTTP na faixa de 200 a 299. O sistema tentará entregar este evento até 5 vezes em caso de falha.", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventContractInstallmentPaid" } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Sempre será `application/json` indicando que o conteúdo do webhook é JSON.", "required": true }, { "name": "User-Agent", "in": "header", "description": "**Header HTTP enviado pelo servidor.** Identifica o sistema que está enviando o webhook. Sempre será `Quyta-Webhooks`.", "required": true }, { "name": "Quyta-Webhook-Signature", "in": "header", "description": "**Header HTTP enviado pelo servidor (opcional).** Assinatura HMAC SHA256 do payload para validação de autenticidade. Este header só será enviado se um secret estiver configurado no webhook.", "required": false } ] } } }, "tags": [ { "name": "Clientes", "description": "Devedores (pessoa física ou jurídica) cadastrados na sua conta. Um cliente precisa existir antes de qualquer dívida ser criada para ele." }, { "name": "Grupos de Dívidas", "description": "Carteiras que agrupam dívidas com a mesma régua de cobrança. São criados no painel da Quyta e apenas consultados pela API." }, { "name": "Dívidas", "description": "Os títulos em aberto que a Quyta cobra. É o recurso central da API: toda a régua de cobrança e os acordos são construídos a partir das dívidas enviadas aqui." } ] }