v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Vendas Gestão de Caixa

Registra recebimento para um Caixa/PDV

Registra recebimento para um Caixa/PDV.

post/v1/caixa/recebimento

Request body

tipoPagamentointeger required

Tipo de Título para o respectivo financeiro. Essa informação deve ser obtida previamente pela entidade "TipoTitulo" (CODTIPTIT). Para saber mais, clique aqui

dataVencimentostring required

Data do vencimento do financeiro.

dataBaixastring required

Data da baixa do recebimento

valorParcelanumber required

Valor total da parcela.

idTransacaostring

ID da transação quando houver. Por exemplo o protocolo da transação PIX.

codigoCaixainteger required

Identificador do Caixa/PDV que está aberto. Esta informação é retonrada ao abrir o caixa e pode ser consultada também pelo endpoint caixa/{codigoPdv}/{cpfOperador}

valorBaixanumber required

Valor da baixa do recebimento

valorJuronumber

Valor de juros do recebimento

valorMultanumber

Valor de multa do recebimento

valorDescontonumber

Valor de desconto do recebimento

identificadorstring

Número identificador do recebívelf, pode ser o código de barras, nosso número, ou algum outra informação que seja capaz de identificar o finaceiro recebido.

observacaostring

codigoTipoOperacaointeger required

Insira o código do Tipo de Operação para realizar a inclusão do Financeiro. Esse código é facilmente acessível através da nossa API, na entidade "TipoOperacao" (CODTIPOPER) com o critério TIPMOV = 'I'. Obtenha essa informação e mantenha seus registros sempreatualizados. Para saber mais, clique aqui

codigoNaturezainteger required

Insira o código da Natureza para realizar a inclusão do Financeiro. Esse código é facilmente acessível através da nossa API, na entidade "Natureza" (CODNAT). Obtenha essa informação e mantenha seus registros sempreatualizados. Para saber mais, clique aqui

codigoProjetointeger

Insira o código do Projeto para realizar a inclusão do Financeiro. Esse código é facilmente acessível através da nossa API, na entidade "Projeto" (CODPROJ). Obtenha essa informação e mantenha seus registros sempreatualizados. Para saber mais, clique aqui

codigoCentroResultadointeger

Insira o código do Centro de Resultado para realizar a inclusão do Financeiro. Esse código é facilmente acessível através da nossa API, na entidade "CentroResultado" (CODCENCUS). Obtenha essa informação e mantenha seus registros sempreatualizados. Para saber mais, clique aqui

codigoParceirointeger required

Insira o código do Parceiro para realizar a inclusão do Financeiro. Esse código é facilmente acessível através da nossa API, na entidade "Parceiro" (CODPARC). Obtenha essa informação e mantenha seus registros sempreatualizados. Para saber mais, clique aqui

Example request

{
  "tipoPagamento": 19,
  "cheque": {
    "codigoBarras": "\"341067330330018805201725766099\"",
    "banco": "341",
    "agencia": "0673",
    "conta": "576609",
    "nome": "José da Silva Souza",
    "cnpjCpf": "14532515955"
  },
  "cartao": {
    "bandeira": "02"
  },
  "dataVencimento": "30/05/2024",
  "dataBaixa": "26/10/2024",
  "valorParcela": 3.38,
  "idTransacao": "dadotiuiwnlkeuhcnhlahdiwlaoaokd48ge65x",
  "codigoCaixa": 348,
  "valorBaixa": 3.4,
  "valorJuro": 0.02,
  "observacao": "Observações para o recebimento",
  "codigoTipoOperacao": 108,
  "codigoNatureza": 101005,
  "codigoProjeto": 10011,
  "codigoCentroResultado": 3004002,
  "codigoParceiro": 1581
}

Response

Operação bem sucedida

codigointeger

tipostring

mensagemstring