Realizar Lançamentos de Entrada da Contabilidade - POST (V3)

Objetivo

A finalidade deste método é possibilitar por meio de um método do tipo POST a realização de lançamentos de entrada da contabilidade.

Chamada

POST api/v3/abaci/accountingentry

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não Há.

Parâmetros do Corpo (Body Parameters)

AccountingEntryPOSTV3DTO

Nome	Descrição	Tipo	Formato	Requerido	Informações Adicionais
accounting_date	Data da Contabilização	string	"dd/MM/yyyy"	Sim	Deve ser informado apenas data, sem a porção de horário.
cod_user	Código do usuário	string		Sim	Código do usuário, o mesmo informado para realizar o login no ambiente web.
allotment_number	Número do lote	integer		Sim	Deve fazer referência à um lote cadastrado na base de dados.
standard_historic	Histórico padrão	string		Não	Descrição do lançamento, máximo de 2.000 caracteres.
company_number	Número da empresa	integer		Sim	Deve fazer referência à uma empresa cadastrada na base de dados.
process_number	Número do processo	string		Não	Ignorar campo.
module	Módulo	string		Não	Ignorar campo.
managerial	Gerencial	string	["S", "N"]	Sim	Informa se o lançamento é gerencial: Sim ("N") ou Não ("N").
extemporaneous	Extemporâneo	string	["S", "N"]	Não	Informa se o lançamento é extemporâneo: Sim ("N") ou Não ("N"). Se não for informado, toma o valor "N" como padrão.
extemporaneous_date	Data Extemporâneo	string	"dd/MM/yyyy"	Não	Se extemporaneous for informado como "S", esse campo passa a ser requerido.
accountt_transactions	Partidas do Lançamento	List<AccountTransactionPOSTV3DTO>		Sim	Representa as partidas do lançamento.
_pageNo	Número da página	integer		Não	Ignorar campo.
_pageSize	Tamanho da página	integer		Não	Ignorar campo.

AccountTransactionPOSTV3DTO

Nome	Descrição	Tipo	Formato	Requerido	Informações Adicionais
account	Conta Contábil	string	["1.0.0.0.13", "100013", "123" ]	Sim	Deve ser informado o número da conta contábil. com ou sem a pontuação, ou então o código reduzido da mesma.
type	Tipo da partida	string	["D", "C"]	Sim	Informa se a partida é débito ("D") ou crédito ("C").
value	Valor	decimal	1234.56	Sim	Valor deve ser positivo.
full_historic	Histórico Completo	string		Não	Descrição da partida. Máximo de 2000 caracteres.
seq_account	Sequencial da Conta Contábil	long		Não	Pode ser usado para informar o sequencial interno da conta contábil. Se for informado, o campo account não precisará ser preenchido então.
num_document	Número de Documento	long		Não	Campo opcional para caso o usuário deseje adicionar lastro em cada partida.
account_transaction_params	Parâmetros da Partida	List<AccountTransactionParamV3POSTDTO>		Sim	Representa os parâmetros da partida.

AccountTransactionParamV3POSTDTO

Nome	Descrição	Tipo	Formato	Requerido	Informações Adicionais
parameter	Parãmetro	string	["E", "PE", "BC", "CX", "T" "U"]	Sim	Parâmetros contábeis: Empresa ("E"), Pessoa ("PE"), Banco ("BC"), Caixa ("CX"), Centro de Resultado ("T") e Grupo Contábil ("U").
parameter_value	Valor do Parâmetro	string		Sim	Código da entidade informada.

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{
  "accounting_date": "31/12/2022",
  "cod_user": "MRRHONORATO",
  "allotment_number": 915,
  "standard_historic": "Lançamento referente à NF 123",
  "company_number": 1,
  "managerial": "N",
  "extemporaneous": "N",
  "extemporaneous_date": "",
  "accountt_transactions": [
    {
      "account": "1.01.01.01.001",
      "type": "D",
      "value": 500.25,
      "full_historic": "Débito referente à OP 1232",
      "seq_account": null,
      "num_document": 1232,
      "account_transaction_params": [
        {
          "parameter": "PE",
          "parameter_value": "1"
        },
        {
          "parameter": "E",
          "parameter_value": "2"
        }
      ]
    },
    {
      "account": "2.01.01.01.001",
      "type": "C",
      "value": 500.25,
      "full_historic": "Crédito referente à Boleto 32123",
      "seq_account": null,
      "num_document": 32123,
      "account_transaction_params": [
        {
          "parameter": "E",
          "parameter_value": "1"
        }
      ]
    }
  ]
}

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome	Descrição	Tipo	Informações Adicionais
new_accounting_entry	Código numérico sequencial do registro que acabou de ser inserido.	double	Não há

Formatos da Resposta (Response Formats)