Financeiro

As facturas a crédito por receber, com o vencimento, o que já foi recebido e o escalão de atraso.

• Permissão DocumentosEmitidos.Ler

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/contas-a-receber' \
  -H 'X-Api-Key: <a-sua-chave>'

O resumo do que há por receber: total em aberto, vencido e a vencer, por escalão.

• Permissão DocumentosEmitidos.Ler

Resposta (200 · JSON)

Exemplo

curl 'https://<endereço-da-API>/api/financeiro/contas-a-receber/resumo' \
  -H 'X-Api-Key: assw_v1_<chave>'

const resposta = await fetch('https://<endereço-da-API>/api/financeiro/contas-a-receber/resumo', {
  method: 'GET',
  headers: {
    "X-Api-Key": "assw_v1_<chave>"
  },
})
const dados = await resposta.json()

import requests

resposta = requests.get(
    'https://<endereço-da-API>/api/financeiro/contas-a-receber/resumo',
    headers={
        'X-Api-Key': 'assw_v1_<chave>'
    },
)
dados = resposta.json()

using var cliente = new HttpClient { BaseAddress = new Uri("https://<endereço-da-API>") };
using var pedido = new HttpRequestMessage(HttpMethod.Get, "/api/financeiro/contas-a-receber/resumo");
pedido.Headers.Add("X-Api-Key", "assw_v1_<chave>");
using var resposta = await cliente.SendAsync(pedido);
var texto = await resposta.Content.ReadAsStringAsync();

content-type: application/json; charset=utf-8
x-mucanda-api-version: 1

{
  "emAberto": 9,
  "valorEmAberto": 977135.29,
  "valorVencido": 943505.29,
  "valorAVencerEm7Dias": 0,
  "valorVencidoAte30Dias": 943505.29,
  "valorVencido31a60Dias": 0,
  "valorVencidoMais60Dias": 0
}

As contas a pagar: compras a fornecedores e despesas.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/contas-a-pagar' \
  -H 'X-Api-Key: <a-sua-chave>'

O resumo do que há por pagar: total em aberto, vencido e a vencer em 7 dias.

• Permissão Financeiro.ContasPagarLer

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

Uma conta a pagar com todos os pagamentos e estornos.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Erros específicos

NAO_ENCONTRADO — além dos gerais.

Exemplo

curl 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651' \
  -H 'X-Api-Key: assw_v1_<chave>'

const resposta = await fetch('https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651', {
  method: 'GET',
  headers: {
    "X-Api-Key": "assw_v1_<chave>"
  },
})
const dados = await resposta.json()

import requests

resposta = requests.get(
    'https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651',
    headers={
        'X-Api-Key': 'assw_v1_<chave>'
    },
)
dados = resposta.json()

using var cliente = new HttpClient { BaseAddress = new Uri("https://<endereço-da-API>") };
using var pedido = new HttpRequestMessage(HttpMethod.Get, "/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651");
pedido.Headers.Add("X-Api-Key", "assw_v1_<chave>");
using var resposta = await cliente.SendAsync(pedido);
var texto = await resposta.Content.ReadAsStringAsync();

content-type: application/json; charset=utf-8
x-mucanda-api-version: 1

{
  "conta": {
    "id": "01a12f69-9cba-7f71-b74d-9d28904a0651",
    "numero": "CP002526",
    "origem": "Despesa",
    "entradaEstoqueId": null,
    "documentoFornecedor": null,
    "fornecedorId": null,
    "fornecedorNome": null,
    "numeroContribuinte": null,
    "lojaId": "01a12201-f4d4-7c07-86b7-e5b24035993e",
    "descricao": "Renda do armazém de Outubro",
    "dataDocumento": "2026-10-11T22:00:00Z",
    "vencimento": "2026-10-21T22:00:00Z",
    "valor": 250000,
    "valorPago": 0,
    "valorCreditado": 0,
    "valorEmAberto": 250000,
    "diasEmAtraso": -9,
    "escalao": "A vencer",
    "situacao": "EmAberto",
    "ultimoPagamentoEmUtc": null,
    "categoriaFinanceiraId": "01a12201-f4d4-7295-b80c-b7026c5ddf68",
    "categoriaNome": "Acertos de contas de cessação",
    "centroCustoId": null,
    "centroCustoNome": null,
    "tipoDocumentoFornecedor": null,
    "baseTributavel": null,
    "ivaSuportado": null,
    "percentagemIvaDedutivel": null,
    "naturezaCompra": null
  },
  "pagamentos": [],
  "notasCredito": []
}

Lança uma despesa (renda, electricidade, serviços): cria uma conta a pagar, paga ou por pagar.

• Permissão Financeiro.ContasPagarCriar
• Idempotência aceita Idempotency-Key

Corpo do pedido (JSON · CriarDespesaCommand)

Resposta

Devolve 201 com { "id": "…" } da conta a pagar.

Erros específicos

ERRO_DE_VALIDACAO · METODO_PAGAMENTO_INACTIVO · PERIODO_FECHADO — além dos gerais.

Exemplo

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/despesas' \
  -H 'Idempotency-Key: f10b2544-8d4d-42f5-8fa5-6fa1c187bb1d' \
  -H 'X-Api-Key: assw_v1_<chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "categoriaFinanceiraId": "01a12201-f4d4-7295-b80c-b7026c5ddf68",
  "descricao": "Renda do armazém de Outubro",
  "valor": 250000,
  "dataDocumento": "2026-10-12",
  "vencimento": "2026-10-22",
  "lojaId": "01a12201-f4d4-7c07-86b7-e5b24035993e"
}'

const resposta = await fetch('https://<endereço-da-API>/api/financeiro/contas-a-pagar/despesas', {
  method: 'POST',
  headers: {
    "Idempotency-Key": "f10b2544-8d4d-42f5-8fa5-6fa1c187bb1d",
    "X-Api-Key": "assw_v1_<chave>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "categoriaFinanceiraId": "01a12201-f4d4-7295-b80c-b7026c5ddf68",
    "descricao": "Renda do armazém de Outubro",
    "valor": 250000,
    "dataDocumento": "2026-10-12",
    "vencimento": "2026-10-22",
    "lojaId": "01a12201-f4d4-7c07-86b7-e5b24035993e"
  }),
})
const dados = await resposta.json()

import requests

resposta = requests.post(
    'https://<endereço-da-API>/api/financeiro/contas-a-pagar/despesas',
    headers={
        'Idempotency-Key': 'f10b2544-8d4d-42f5-8fa5-6fa1c187bb1d',
        'X-Api-Key': 'assw_v1_<chave>',
        'Content-Type': 'application/json'
    },
    json={
        'categoriaFinanceiraId': '01a12201-f4d4-7295-b80c-b7026c5ddf68',
        'descricao': 'Renda do armazém de Outubro',
        'valor': 250000,
        'dataDocumento': '2026-10-12',
        'vencimento': '2026-10-22',
        'lojaId': '01a12201-f4d4-7c07-86b7-e5b24035993e'
    },
)
dados = resposta.json()

using var cliente = new HttpClient { BaseAddress = new Uri("https://<endereço-da-API>") };
using var pedido = new HttpRequestMessage(HttpMethod.Post, "/api/financeiro/contas-a-pagar/despesas");
pedido.Headers.Add("Idempotency-Key", "f10b2544-8d4d-42f5-8fa5-6fa1c187bb1d");
pedido.Headers.Add("X-Api-Key", "assw_v1_<chave>");
pedido.Content = new StringContent("""
{
  "categoriaFinanceiraId": "01a12201-f4d4-7295-b80c-b7026c5ddf68",
  "descricao": "Renda do armazém de Outubro",
  "valor": 250000,
  "dataDocumento": "2026-10-12",
  "vencimento": "2026-10-22",
  "lojaId": "01a12201-f4d4-7c07-86b7-e5b24035993e"
}
""", Encoding.UTF8, "application/json");
using var resposta = await cliente.SendAsync(pedido);
var texto = await resposta.Content.ReadAsStringAsync();

content-type: application/json; charset=utf-8
x-mucanda-api-version: 1
location: /api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651

{
  "id": "01a12f69-9cba-7f71-b74d-9d28904a0651"
}

Regista um pagamento, parcial ou total, de uma conta a pagar.

• Permissão Financeiro.ContasPagarPagar
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · RegistarPagamentoRequest)

Resposta

Devolve 201 com { "id": "…" } do pagamento.

Erros específicos

METODO_PAGAMENTO_INACTIVO · PERIODO_FECHADO — além dos gerais.

Exemplo

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651/pagamentos' \
  -H 'Idempotency-Key: 74020947-01c7-4761-b6fb-44814ba472bc' \
  -H 'X-Api-Key: assw_v1_<chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "metodoPagamentoId": "9dde532b-0092-4a68-b2dc-18649f0c97c4",
  "valor": 100000,
  "juros": 0,
  "desconto": 0
}'

const resposta = await fetch('https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651/pagamentos', {
  method: 'POST',
  headers: {
    "Idempotency-Key": "74020947-01c7-4761-b6fb-44814ba472bc",
    "X-Api-Key": "assw_v1_<chave>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "metodoPagamentoId": "9dde532b-0092-4a68-b2dc-18649f0c97c4",
    "valor": 100000,
    "juros": 0,
    "desconto": 0
  }),
})
const dados = await resposta.json()

import requests

resposta = requests.post(
    'https://<endereço-da-API>/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651/pagamentos',
    headers={
        'Idempotency-Key': '74020947-01c7-4761-b6fb-44814ba472bc',
        'X-Api-Key': 'assw_v1_<chave>',
        'Content-Type': 'application/json'
    },
    json={
        'metodoPagamentoId': '9dde532b-0092-4a68-b2dc-18649f0c97c4',
        'valor': 100000,
        'juros': 0,
        'desconto': 0
    },
)
dados = resposta.json()

using var cliente = new HttpClient { BaseAddress = new Uri("https://<endereço-da-API>") };
using var pedido = new HttpRequestMessage(HttpMethod.Post, "/api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651/pagamentos");
pedido.Headers.Add("Idempotency-Key", "74020947-01c7-4761-b6fb-44814ba472bc");
pedido.Headers.Add("X-Api-Key", "assw_v1_<chave>");
pedido.Content = new StringContent("""
{
  "metodoPagamentoId": "9dde532b-0092-4a68-b2dc-18649f0c97c4",
  "valor": 100000,
  "juros": 0,
  "desconto": 0
}
""", Encoding.UTF8, "application/json");
using var resposta = await cliente.SendAsync(pedido);
var texto = await resposta.Content.ReadAsStringAsync();

content-type: application/json; charset=utf-8
x-mucanda-api-version: 1
location: /api/financeiro/contas-a-pagar/01a12f69-9cba-7f71-b74d-9d28904a0651

{
  "id": "01a12f69-9d06-7c6c-b060-777703ce8592"
}

As categorias financeiras (de despesa e de receita), para classificar uma despesa.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Exemplo

curl 'https://<endereço-da-API>/api/financeiro/categorias?tipo=Despesa' \
  -H 'X-Api-Key: assw_v1_<chave>'

const resposta = await fetch('https://<endereço-da-API>/api/financeiro/categorias?tipo=Despesa', {
  method: 'GET',
  headers: {
    "X-Api-Key": "assw_v1_<chave>"
  },
})
const dados = await resposta.json()

import requests

resposta = requests.get(
    'https://<endereço-da-API>/api/financeiro/categorias?tipo=Despesa',
    headers={
        'X-Api-Key': 'assw_v1_<chave>'
    },
)
dados = resposta.json()

using var cliente = new HttpClient { BaseAddress = new Uri("https://<endereço-da-API>") };
using var pedido = new HttpRequestMessage(HttpMethod.Get, "/api/financeiro/categorias?tipo=Despesa");
pedido.Headers.Add("X-Api-Key", "assw_v1_<chave>");
using var resposta = await cliente.SendAsync(pedido);
var texto = await resposta.Content.ReadAsStringAsync();

content-type: application/json; charset=utf-8
x-mucanda-api-version: 1

[
  {
    "id": "01a12201-f4d4-7295-b80c-b7026c5ddf68",
    "tipo": "Despesa",
    "nome": "Acertos de contas de cessação",
    "activa": true,
    "deSistema": true,
    "actividade": "Operacional",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-766b-85fe-5a7fed7ddf11",
    "tipo": "Despesa",
    "nome": "Alimentação",
    "activa": true,
    "deSistema": false,
    "actividade": "Operacional",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-7da5-9bdf-6bed9af13af6",
    "tipo": "Despesa",
    "nome": "Amortização de empréstimos",
    "activa": true,
    "deSistema": false,
    "actividade": "Financiamento",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-7420-a0ca-c2c9bed0ef8c",
    "tipo": "Despesa",
    "nome": "Compra de equipamento",
    "activa": true,
    "deSistema": false,
    "actividade": "Investimento",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-7ee6-8b97-4deb8a6fa820",
    "tipo": "Despesa",
    "nome": "Compra de mercadorias",
    "activa": true,
    "deSistema": true,
    "actividade": "Operacional",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-7844-9dd4-70708d97a611",
    "tipo": "Despesa",
    "nome": "Consumíveis de escritório",
    "activa": true,
    "deSistema": false,
    "actividade": "Operacional",
    "naturezaCompraPorOmissao": null
  },
  {
    "id": "01a12201-f4d4-7d9a-8e4b-d6b62cf1fb60",
    "tipo": "Despesa",
    "nome": "Energia",
    "activa": true,
  …

Os centros de custo da empresa, para imputar as despesas.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/centros-custo' \
  -H 'X-Api-Key: <a-sua-chave>'

Regista uma nota de crédito do fornecedor sobre uma conta a pagar: abate o que falta pagar.

• Permissão Financeiro.ContasPagarNotaCredito
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · RegistarNotaCreditoRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/<id>/notas-credito' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "numero": "texto",
  "data": "2026-10-12T09:00:00Z",
  "baseTributavel": 0,
  "ivaSuportado": 0,
  "valor": 0,
  "motivo": "texto"
}'

O resumo das despesas do mês corrente: total lançado, já pago e por pagar.

• Permissão Financeiro.ContasPagarLer

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/despesas/resumo-mes' \
  -H 'X-Api-Key: <a-sua-chave>'

Anula uma despesa que ainda não tem pagamentos.

• Permissão Financeiro.ContasPagarCriar
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · AnularDespesaRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/<id>/anular' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'

Estorna um pagamento a um fornecedor: a dívida reabre.

• Permissão Financeiro.ContasPagarEstornar
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · EstornarPagamentoRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/contas-a-pagar/<id>/pagamentos/<pagamentoId>/estornar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'

As despesas recorrentes (renda, seguros, rendas de equipamento…).

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes' \
  -H 'X-Api-Key: <a-sua-chave>'

O resumo das despesas recorrentes: quantas, quanto por mês e quantas estão pendentes de lançar.

• Permissão Financeiro.ContasPagarLer

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/resumo' \
  -H 'X-Api-Key: <a-sua-chave>'

A ficha de uma despesa recorrente, com as despesas que já gerou.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

Cria uma despesa recorrente.

• Permissão Financeiro.ContasPagarCriar
• Idempotência aceita Idempotency-Key

Corpo do pedido (JSON · CriarDespesaRecorrenteCommand)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "categoriaFinanceiraId": "00000000-0000-0000-0000-000000000000",
  "descricao": "texto",
  "valor": 0,
  "frequencia": "Mensal",
  "diaLancamento": 1,
  "prazoPagamentoDias": 1,
  "dataInicio": "2026-10-12"
}'

Altera uma despesa recorrente; vale para os ciclos seguintes.

• Permissão Financeiro.ContasPagarCriar

Parâmetros

Corpo do pedido (JSON · EditarDespesaRecorrenteRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "descricao": "texto",
  "valor": 0,
  "categoriaFinanceiraId": "00000000-0000-0000-0000-000000000000",
  "prazoPagamentoDias": 1
}'

Pausa uma despesa recorrente: deixa de lançar até ser retomada.

• Permissão Financeiro.ContasPagarCriar

Parâmetros

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/<id>/pausar' \
  -H 'X-Api-Key: <a-sua-chave>'

Retoma uma despesa recorrente pausada.

• Permissão Financeiro.ContasPagarCriar

Parâmetros

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/<id>/retomar' \
  -H 'X-Api-Key: <a-sua-chave>'

Cancela uma despesa recorrente: não volta a lançar. As despesas já lançadas mantêm-se.

• Permissão Financeiro.ContasPagarCriar

Parâmetros

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/<id>/cancelar' \
  -H 'X-Api-Key: <a-sua-chave>'

Lança agora todas as despesas recorrentes que estão por lançar.

• Permissão Financeiro.ContasPagarCriar

Resposta (200 · JSON)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/despesas-recorrentes/lancar-pendentes' \
  -H 'X-Api-Key: <a-sua-chave>'

O Mapa de Fornecedores de um mês, para a declaração à AGT: a pré-visualização.

• Permissão Saft.Exportar

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/mapa-fornecedores' \
  -H 'X-Api-Key: <a-sua-chave>'

O Mapa de Fornecedores de um mês no modelo Excel da AGT.

• Permissão Saft.Exportar

Parâmetros

Resposta

Devolve 200 com o ficheiro Excel (.xlsx).

Pedido

curl 'https://<endereço-da-API>/api/financeiro/mapa-fornecedores/excel' \
  -H 'X-Api-Key: <a-sua-chave>'

Cria uma categoria financeira (de receita ou de despesa).

• Permissão Financeiro.CategoriasEditar
• Idempotência aceita Idempotency-Key

Corpo do pedido (JSON · CriarCategoriaFinanceiraCommand)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/categorias' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "tipo": "Receita",
  "nome": "texto"
}'

Renomeia uma categoria financeira.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · NomeRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/categorias/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto"
}'

Define a actividade do fluxo de caixa a que uma categoria pertence.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · ActividadeRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/categorias/<id>/actividade' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "actividade": "Operacional"
}'

Define a natureza fiscal da compra por omissão de uma categoria de despesa.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · ValoresFiscaisCategoriaRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/categorias/<id>/valores-fiscais' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Activa ou desactiva uma categoria financeira.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · ActivaRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/categorias/<id>/activa' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activa": false
}'

Cria um centro de custo.

• Permissão Financeiro.CategoriasEditar
• Idempotência aceita Idempotency-Key

Corpo do pedido (JSON · CriarCentroCustoCommand)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/centros-custo' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto"
}'

Renomeia um centro de custo.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · NomeRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/centros-custo/<id>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto"
}'

Activa ou desactiva um centro de custo.

• Permissão Financeiro.CategoriasEditar

Parâmetros

Corpo do pedido (JSON · ActivoRequest)

Pedido

curl -X PUT 'https://<endereço-da-API>/api/financeiro/centros-custo/<id>/activo' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "activo": false
}'

Os créditos a favor da empresa junto dos fornecedores (o que sobra de uma nota de crédito sobre uma factura já paga).

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/creditos-fornecedor' \
  -H 'X-Api-Key: <a-sua-chave>'

Um crédito de fornecedor, com as utilizações que já teve.

• Permissão Financeiro.ContasPagarLer

Parâmetros

Resposta (200 · JSON)

Pedido

curl 'https://<endereço-da-API>/api/financeiro/creditos-fornecedor/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

Usa um crédito para abater outra conta a pagar do mesmo fornecedor.

• Permissão Financeiro.ContasPagarNotaCredito
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · CompensarCreditoRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/creditos-fornecedor/<id>/compensar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "contaAPagarId": "00000000-0000-0000-0000-000000000000",
  "valor": 0
}'

Recebe um crédito em dinheiro: o fornecedor devolve o valor à empresa.

• Permissão Financeiro.ContasPagarNotaCredito
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · ReembolsarCreditoRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/creditos-fornecedor/<id>/reembolsar' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "metodoPagamentoId": "00000000-0000-0000-0000-000000000000",
  "valor": 0
}'

Desfaz uma utilização de um crédito (uma compensação ou um reembolso), com o motivo.

• Permissão Financeiro.ContasPagarNotaCredito
• Idempotência aceita Idempotency-Key

Parâmetros

Corpo do pedido (JSON · DesfazerUtilizacaoRequest)

Pedido

curl -X POST 'https://<endereço-da-API>/api/financeiro/creditos-fornecedor/utilizacoes/<utilizacaoId>/desfazer' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "motivo": "texto"
}'