Histórico da Página

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):

[
{
"seq_accounting_entry": 0,
"accounting_date": "2021-01-25T13:56:47.616Z",
"addition_date": "2021-01-25T13:56:47.616Z",
"seq_allotment": 0,
"allotment_number": 0,
"seq_historic": 0,
"value": 0,
"seq_standard_historic": 0,
"standard_historic": "string",
"company_number": 0,
"process_number": "string",
"settlement": "string",
"module": "string",
"transaction_quantity": 0,
"seq_status": "string",
"extemporaneous": "string",
"extemporaneous_date": "2021-01-25T13:56:47.616Z",
"type": "string",
"managerial": "string",
"account_transactions": [
{
"seq_account_transaction": 0,
"seq_account": 0,
"account": "string",
"type": "string",
"value": 0,
"num_document": 0,
"account_transaction_parameters": [
{
"seq_account_parameter": 0,
"seq_parameter": "string",
"parameter": "string",
"ref_code": "string"
}
]
}
]
}
]

application/xml, text/xml

Exemplo (Sample):

<?xml version="1.0"?>
<Inline Model>
<seq_accounting_entry>1</seq_accounting_entry>
<accounting_date>1970-01-01T00:00:00.001Z</accounting_date>
<addition_date>1970-01-01T00:00:00.001Z</addition_date>
<seq_allotment>1</seq_allotment>
<allotment_number>1</allotment_number>
<seq_historic>1</seq_historic>
<value>1.1</value>
<seq_standard_historic>1</seq_standard_historic>
<standard_historic>string</standard_historic>
<company_number>1</company_number>
<process_number>string</process_number>
<settlement>string</settlement>
<module>string</module>
<transaction_quantity>1</transaction_quantity>
<seq_status>string</seq_status>
<extemporaneous>string</extemporaneous>
<extemporaneous_date>1970-01-01T00:00:00.001Z</extemporaneous_date>
<type>string</type>
<managerial>string</managerial>
<account_transactions>
<seq_account_transaction>1</seq_account_transaction>
<seq_account>1</seq_account>
<account>string</account>
<type>string</type>
<value>1.1</value>
<num_document>1</num_document>
<account_transaction_parameters>
<seq_account_parameter>1</seq_account_parameter>
<seq_parameter>string</seq_parameter>
<parameter>string</parameter>
<ref_code>string</ref_code>
</account_transaction_parameters>
</account_transactions>
</Inline Model>

application/x-www-form-urlencoded

Exemplo (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

AccountingEntryV2DTO

Collection of AccountingEntryResponceV2DTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
seq_accounting_entry	Código numérico sequencial do registro	integer	Não há
accounting_date	Data da Contabilização	date	Não há
addition_date	Data da Inclusão	date	Não há
seq_allotment	Código numérico sequencial do lote	integer	Não há
allotment_number	Número do Lote	integer	Não há
seq_historic	Código numérico sequencial do histórico (opcional)	integer	Não há
value	Valor da Entrada	decimal number	Não há
seq_standard_historic	Código numérico sequencial padrão do histórico (opcional)	integer	Não há
standard_historic	Histórico padrão	string	Não há
company_number	Número da empresa	integer	Não há
process_number	Número do processo	string	Não há
settlement	Liquidação	string	Não há
module	Módulo	string	Não há
transaction_quantity	Quantidade da Transação	integer	Não há
seq_status	Código sequencial do Status	string	Não há
extemporaneous	Valor “S” para extemporâneo: retorna apenas os registros extemporâneos da contabilização. Valor “N”: Todos os registros.	string	Não há
extemporaneous_date	Retorna apenas os registros extemporâneos da contabilidade com data igual a informada.	date	Não há
type	Tipo	string	Não há
managerial	Gerencial	string	Não há
account_transactions		Collection of AccountTransactionV3DTO	Não há.

Formatos da Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
"accounting_date": "string",
"cod_user": "string",
"allotment_number": 0,
"standard_historic": "string",
"company_number": 0,
"process_number": "string",
"module": "string",
"managerial": "string",
"extemporaneous": "string",
"extemporaneous_date": "string",
"accountt_transactions": [
{
"account": "string",
"type": "string",
"value": 0,
"full_historic": "string",
"seq_account": 0,
"num_document": 0,
"account_transaction_params": [
{
"parameter": "string",
"parameter_value": "string"
}
]
}
],
"_pageNo": 0,
"_pageSize": 0
}

application/xml, text/xml

Exemplo (Sample):

<?xml version="1.0"?>
<AccountingEntryV3POSTDTO>
<accounting_date>string</accounting_date>
<cod_user>string</cod_user>
<allotment_number>1</allotment_number>
<standard_historic>string</standard_historic>
<company_number>1</company_number>
<process_number>string</process_number>
<module>string</module>
<managerial>string</managerial>
<extemporaneous>string</extemporaneous>
<extemporaneous_date>string</extemporaneous_date>
<accountt_transactions>
<account>string</account>
<type>string</type>
<value>1.1</value>
<full_historic>string</full_historic>
<seq_account>1</seq_account>
<num_document>1</num_document>
<account_transaction_params>
<parameter>string</parameter>
<parameter_value>string</parameter_value>
</account_transaction_params>
</accountt_transactions>
<_pageNo>1</_pageNo>
<_pageSize>1</_pageSize>
</AccountingEntryV3POSTDTO>

Árvore de páginas

Versões comparadas

Versão antiga 7

Nova versão 8

Chave

Objetivo

Chamada

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

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Formatos da Requisição (Request Formats)

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Formatos da Resposta (Response Formats)