Contas a Pagar · miCore

O que é

Contas a Pagar reúne as despesas da empresa: contas na carteira (boletos, contas de consumo, fornecedores) e compras no cartão de crédito, que entram na fatura do cartão.

A API usa as mesmas regras do painel: a mesma divisão de parcelas, a mesma regra de fatura e as mesmas permissões.

O que dá para fazer hoje

Descobrir carteiras, cartões e categorias válidos.
Listar contas com filtros de situação e vencimento.
Lançar uma conta na carteira ou uma compra no cartão.
Lançar uma compra parcelada com o total dividido automaticamente.
Editar, pagar e apagar as parcelas em aberto de uma compra.

Importante

No cartão, a fatura é decidida pelo dia de fechamento do cartão, não pelo mês da compra.
Na listagem, as compras no cartão aparecem dentro da fatura (kind = invoice); filtre por invoice_id para ver as compras.
Compra no cartão não é paga sozinha: pague a fatura.

Disponibilidade na API

Endpoints de Contas a Pagar

Liste, lance, parcele, edite e pague contas a pagar, na carteira ou no cartão. Os exemplos abaixo são gerados pelo contrato OpenAPI oficial.

GET /api/v1/payables

Lista contas a pagar

Lista as contas a pagar das lojas do usuário. Compras no cartão aparecem dentro da fatura; filtre por card_id ou invoice_id para vê-las.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`status`query	string	Não	—
`due_from`query	string (date)	Não	—
`due_to`query	string (date)	Não	—
`category_id`query	integer	Não	—
`wallet_id`query	integer	Não	—
`card_id`query	integer	Não	—
`store_id`query	integer	Não	—
`invoice_id`query	integer	Não	Compras de uma fatura do cartão.
`installment_group`query	integer	Não	Parcelas da mesma compra.
`search`query	string	Não	—
`per_page`query	integer	Não	—

Exemplo de requisição

cURL

curl "$MICORE_BASE_URL/payables" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "description": "string",
            "value": 1,
            "value_paid": 1,
            "fees": 1,
            "status": "open",
            "kind": "bill",
            "purchase_date": "2026-10-20",
            "due_date": "2026-10-20",
            "paid_at": "2026-10-20",
            "category": {
                "id": 1,
                "name": "string"
            },
            "store_id": 1,
            "wallet_id": 1,
            "card_id": 1,
            "invoice_id": 1,
            "installment_group": 1,
            "relationship": {
                "type": "fornecedor",
                "id": 1
            },
            "payment_method": "string",
            "recurrence_id": 1,
            "created_at": "2026-10-20T10:00:00-03:00"
        }
    ]
}

Respostas possíveis

200 Página de contas a pagar401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente422 Dados inválidos

POST /api/v1/payables

Lança uma conta a pagar

Lança uma conta na carteira (due_date obrigatório) ou uma compra no cartão (purchase_date obrigatório). No cartão, a compra entra na fatura pelo dia de fechamento: antes do fechamento, na fatura do mês; no dia do fechamento ou depois, na seguinte.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`Idempotency-Key`header	string	Sim	Identificador único da mutação, com 8 a 100 caracteres. O resultado fica reutilizável por 24 horas e a chave não pode ser reutilizada depois de expirar.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Até 191 caracteres.
`description`	string	Não	—
`value`	number	Sim	—
`category_id`	integer	Sim	—
`store_id`	integer	Sim	—
`method`	string	Sim	Valores: wallet, card.
`method_id`	integer	Sim	Id da carteira ou do cartão (veja /payable-options).
`purchase_date`	string (date)	Não	Obrigatória no cartão: define a fatura.
`due_date`	string (date)	Não	Obrigatório na carteira.
`relationship`	string	Não	Valores: fornecedor, colaborador, cliente.
`relationship_id`	integer	Não	—
`payment_method`	string	Não	—
`paid`	boolean	Não	Só na carteira.
`value_paid`	number	Não	—
`paid_at`	string (date)	Não	—

Exemplo de requisição

cURL

curl -X POST "$MICORE_BASE_URL/payables" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: board-request-0001" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","value":1,"category_id":1,"store_id":1,"method":"wallet","method_id":1,"purchase_date":"2026-10-20","due_date":"2026-10-20","relationship":"fornecedor","relationship_id":1,"payment_method":"string","paid":true,"value_paid":1,"paid_at":"2026-10-20"}'

Exemplo de resposta JSON

Resposta · 201

{
    "data": {
        "id": 1,
        "name": "string",
        "description": "string",
        "value": 1,
        "value_paid": 1,
        "fees": 1,
        "status": "open",
        "kind": "bill",
        "purchase_date": "2026-10-20",
        "due_date": "2026-10-20",
        "paid_at": "2026-10-20",
        "category": {
            "id": 1,
            "name": "string"
        },
        "store_id": 1,
        "wallet_id": 1,
        "card_id": 1,
        "invoice_id": 1,
        "installment_group": 1,
        "relationship": {
            "type": "fornecedor",
            "id": 1
        },
        "payment_method": "string",
        "recurrence_id": 1,
        "created_at": "2026-10-20T10:00:00-03:00"
    }
}

Respostas possíveis

201 Conta criada ou reapresentada pela mesma chave idempotente401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente409 Chave em processamento ou reutilizada com outro conteúdo422 Dados inválidos

GET /api/v1/payable-options

Carteiras, cartões e categorias para lançar

Ids válidos para lançar: carteiras das lojas do usuário, cartões com dia de fechamento e vencimento, e categorias de contas a pagar.

Exemplo de requisição

cURL

curl "$MICORE_BASE_URL/payable-options" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "wallets": [
            {
                "id": 1,
                "name": "string",
                "store_id": 1
            }
        ],
        "cards": [
            {
                "id": 1,
                "name": "string",
                "last_digits": 1,
                "closing_day": 1,
                "due_day": 1,
                "limit": 1
            }
        ],
        "categories": [
            {
                "id": 1,
                "name": "string",
                "parent_id": 1
            }
        ],
        "relationships": [
            "string"
        ]
    }
}

Respostas possíveis

200 Opções de lançamento401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente

POST /api/v1/payables/installments

Lança uma compra parcelada

Divide total_value em parcelas mensais em centavos inteiros, com o resto na 1ª (R$ 100 em 3x = 33,34 + 33,33 + 33,33). No cartão, cada parcela é uma compra no mesmo dia dos meses seguintes e cai na fatura certa; na carteira, vence no due_day de cada mês. Datas nunca pulam mês.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`Idempotency-Key`header	string	Sim	Identificador único da mutação, com 8 a 100 caracteres. O resultado fica reutilizável por 24 horas e a chave não pode ser reutilizada depois de expirar.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Até 160 caracteres.
`description`	string	Não	—
`total_value`	number	Sim	—
`installments`	integer	Sim	—
`category_id`	integer	Sim	—
`store_id`	integer	Sim	—
`method`	string	Sim	Valores: wallet, card.
`method_id`	integer	Sim	—
`purchase_date`	string (date)	Sim	—
`due_day`	integer	Não	Obrigatório na carteira: dia de vencimento de cada parcela.
`name_style`	string	Não	installment = Nome \| Parcela n/total; reference = Nome \| Ref: mm/aaaa; plain = só o nome. Valores: installment, reference, plain. Padrão: "installment".
`relationship`	string	Não	Valores: fornecedor, colaborador, cliente.
`relationship_id`	integer	Não	—
`payment_method`	string	Não	—

Exemplo de requisição

cURL

curl -X POST "$MICORE_BASE_URL/payables/installments" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: board-request-0001" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","total_value":1,"installments":1,"category_id":1,"store_id":1,"method":"wallet","method_id":1,"purchase_date":"2026-10-20","due_day":1,"name_style":"installment","relationship":"fornecedor","relationship_id":1,"payment_method":"string"}'

Exemplo de resposta JSON

Resposta · 201

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "description": "string",
            "value": 1,
            "value_paid": 1,
            "fees": 1,
            "status": "open",
            "kind": "bill",
            "purchase_date": "2026-10-20",
            "due_date": "2026-10-20",
            "paid_at": "2026-10-20",
            "category": {
                "id": 1,
                "name": "string"
            },
            "store_id": 1,
            "wallet_id": 1,
            "card_id": 1,
            "invoice_id": 1,
            "installment_group": 1,
            "relationship": {
                "type": "fornecedor",
                "id": 1
            },
            "payment_method": "string",
            "recurrence_id": 1,
            "created_at": "2026-10-20T10:00:00-03:00"
        }
    ]
}

Respostas possíveis

201 Parcelas criadas ou reapresentadas pela mesma chave idempotente401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente409 Chave em processamento ou reutilizada com outro conteúdo422 Dados inválidos

GET /api/v1/payables/{payable}

Consulta uma conta a pagar

Exemplo de requisição

cURL

curl "$MICORE_BASE_URL/payables/{payable}" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "id": 1,
        "name": "string",
        "description": "string",
        "value": 1,
        "value_paid": 1,
        "fees": 1,
        "status": "open",
        "kind": "bill",
        "purchase_date": "2026-10-20",
        "due_date": "2026-10-20",
        "paid_at": "2026-10-20",
        "category": {
            "id": 1,
            "name": "string"
        },
        "store_id": 1,
        "wallet_id": 1,
        "card_id": 1,
        "invoice_id": 1,
        "installment_group": 1,
        "relationship": {
            "type": "fornecedor",
            "id": 1
        },
        "payment_method": "string",
        "recurrence_id": 1,
        "created_at": "2026-10-20T10:00:00-03:00"
    }
}

Respostas possíveis

200 Conta a pagar401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado

PATCH /api/v1/payables/{payable}

Edita uma conta a pagar

Edita os campos enviados. Compra no cartão muda de fatura se a data da compra mudar; não troca de cartão. O pagamento não muda aqui: use /payables/{payable}/pay.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Não	Até 191 caracteres.
`description`	string	Não	—
`value`	number	Não	—
`category_id`	integer	Não	—
`store_id`	integer	Não	—
`wallet_id`	integer	Não	Só para conta na carteira.
`purchase_date`	string (date)	Não	—
`due_date`	string (date)	Não	Ignorado em compra no cartão e em fatura.
`relationship`	string	Não	Valores: fornecedor, colaborador, cliente.
`relationship_id`	integer	Não	—
`payment_method`	string	Não	—

Exemplo de requisição

cURL

curl -X PATCH "$MICORE_BASE_URL/payables/{payable}" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","value":1,"category_id":1,"store_id":1,"wallet_id":1,"purchase_date":"2026-10-20","due_date":"2026-10-20","relationship":"fornecedor","relationship_id":1,"payment_method":"string"}'

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "id": 1,
        "name": "string",
        "description": "string",
        "value": 1,
        "value_paid": 1,
        "fees": 1,
        "status": "open",
        "kind": "bill",
        "purchase_date": "2026-10-20",
        "due_date": "2026-10-20",
        "paid_at": "2026-10-20",
        "category": {
            "id": 1,
            "name": "string"
        },
        "store_id": 1,
        "wallet_id": 1,
        "card_id": 1,
        "invoice_id": 1,
        "installment_group": 1,
        "relationship": {
            "type": "fornecedor",
            "id": 1
        },
        "payment_method": "string",
        "recurrence_id": 1,
        "created_at": "2026-10-20T10:00:00-03:00"
    }
}

Respostas possíveis

200 Conta atualizada401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado422 Dados inválidos

POST /api/v1/payables/{payable}/pay

Marca a conta como paga

Marca como paga, com a data (padrão hoje) e o valor pago (padrão o valor da conta; acima dele vira juros). Compra no cartão não é paga sozinha: pague a fatura (kind invoice).

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`paid_at`	string (date)	Não	—
`value_paid`	number	Não	—

Exemplo de requisição

cURL

curl -X POST "$MICORE_BASE_URL/payables/{payable}/pay" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"paid_at":"2026-10-20","value_paid":1}'

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "id": 1,
        "name": "string",
        "description": "string",
        "value": 1,
        "value_paid": 1,
        "fees": 1,
        "status": "open",
        "kind": "bill",
        "purchase_date": "2026-10-20",
        "due_date": "2026-10-20",
        "paid_at": "2026-10-20",
        "category": {
            "id": 1,
            "name": "string"
        },
        "store_id": 1,
        "wallet_id": 1,
        "card_id": 1,
        "invoice_id": 1,
        "installment_group": 1,
        "relationship": {
            "type": "fornecedor",
            "id": 1
        },
        "payment_method": "string",
        "recurrence_id": 1,
        "created_at": "2026-10-20T10:00:00-03:00"
    }
}

Respostas possíveis

200 Conta paga401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado422 Dados inválidos

DELETE /api/v1/payables/{payable}/installments

Apaga as parcelas em aberto da compra

Apaga as parcelas ainda não pagas da mesma compra parcelada desta conta. As pagas ficam. No cartão, a fatura é recalculada.

Exemplo de requisição

cURL

curl -X DELETE "$MICORE_BASE_URL/payables/{payable}/installments" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json"

Exemplo de resposta JSON

Resposta · 200

{
    "data": {
        "deleted": 1
    }
}

Respostas possíveis

200 Parcelas apagadas401 Token ausente, inválido, expirado ou revogado403 Escopo, assinatura, módulo ou permissão insuficiente404 Recurso não encontrado422 Dados inválidos