Pular para o conteúdo principal

Criar Conta a Pagar

Registra uma nova conta a pagar no sistema.

Endpoint​

POST /contas-pagar

Body​

{
   "data": {
      "codigo_lancamento_integracao": string,
      "codigo_cliente_fornecedor": number,
      "codigo_cliente_fornecedor_integracao": string,
      "data_vencimento": string,
      "valor_documento": number,
      "codigo_categoria": string,
      "categorias": [
         {
            "codigo_categoria": string,
            "percentual": number,
            "valor": number
         }
      ],
      "data_previsao": string,
      "id_conta_corrente": number,
      "numero_documento_fiscal": string,
      "data_emissao": string,
      "data_entrada": string,
      "codigo_projeto": number,
      "observacao": string,
      "valor_pis": number,
      "retem_pis": string,
      "valor_cofins": number,
      "retem_cofins": string,
      "valor_csll": number,
      "retem_csll": string,
      "valor_ir": number,
      "retem_ir": string,
      "valor_iss": number,
      "retem_iss": string,
      "valor_inss": number,
      "retem_inss": string,
      "distribuicao": [
         {
            "cCodDep": string,
            "cDesDep": string,
            "nPerDep": number,
            "nValDep": number
         }
      ],
      "numero_pedido": string,
      "codigo_tipo_documento": string,
      "numero_documento": string,
      "numero_parcela": string,
      "chave_nfe": string,
      "codigo_barras_ficha_compensacao": string,
      "codigo_vendedor": number,
      "id_origem": string,
      "info": {
         "cImpAPI": string,
         "dAlt": string,
         "dInc": string,
         "hAlt": string,
         "hInc": string,
         "uAlt": string,
         "uInc": string
      },
      "operacao": string,
      "status_titulo": string,
      "nsu": string,
      "acao": string,
      "id_conta_corrente_integracao": string,
      "bloqueado": string,
      "baixa_bloqueada": string,
      "codigo_cmc7_cheque": string,
      "importado_api": string,
      "bloquear_exclusao": string,
      "cnab_integracao_bancaria": {
         "codigo_forma_pagamento": string,
         "banco_transferencia": string,
         "agencia_transferencia": string,
         "conta_corrente_transferencia": string,
         "finalidade_transferencia": string,
         "cpf_cnpj_transferencia": string,
         "nome_transferencia": string,
         "codigo_barras_boleto": string,
         "juros_boleto": number,
         "multa_boleto": number,
         "pix_qrcode": string
      },
      "servico_tomado": {
         "numero_nf": string,
         "serie_nf": string,
         "codigo_servico": string,
         "valor_nf": number,
         "cst_pis": string,
         "base_pis": number,
         "aliquota_pis": number,
         "valor_pis": number,
         "cst_cofins": string,
         "base_cofins": number,
         "aliquota_cofins": number,
         "valor_cofins": number
      },
      "valor_pag": number,
      "aprendizado_rateio": string
   }
}

Exemplo de Request​

{
   "data": {
      "codigo_lancamento_integracao": "INT001",
      "codigo_cliente_fornecedor": 12345,
      "codigo_cliente_fornecedor_integracao": "FOR001",
      "data_vencimento": "2024-03-15",
      "valor_documento": 1500.00,
      "codigo_categoria": "DESPESAS",
      "categorias": [
         {
            "codigo_categoria": "DESPESAS",
            "percentual": 100,
            "valor": 1500.00
         }
      ],
      "data_previsao": "2024-03-15",
      "id_conta_corrente": 1,
      "numero_documento": "DOC001",
      "numero_parcela": "1/1",
      "codigo_tipo_documento": "BOLETO",
      "observacao": "Aluguel do mês de março",
      "status_titulo": "EM ABERTO"
   }
}

Resposta​

Pelo momento a resposta é apenas a resposta padrão do pacote MySQL2

{
   "fieldCount": number,
   "affectedRows": number,
   "insertId": number,
   "info": "Rows matched: number  Changed: number  Warnings: number",
   "serverStatus": number,
   "warningStatus": number,
   "changedRows": number
}

Exemplo de Resposta​

{
   "fieldCount": 3,
   "affectedRows": 1,
   "insertId": 143,
   "info": "Rows matched: 1 Changed: 1 Warnings: 0",
   "serverStatus": 0,
   "warningStatus": 0,
   "changedRows": 1
}

Códigos de Status​

  • 201: Criado com sucesso
  • 400: Requisição inválida
  • 401: Não autorizado
  • 403: Acesso proibido
  • 500: Erro interno do servidor