Histórico da Página

...

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/v2v3/abaci/accountingentry

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

...

Parâmetros do Corpo (Body Parameters)

AccountingEntryPOSTV2DTOAccountingEntryPOSTV3DTO

Nome

(Name)

Descrição

(Description)

Tipo

(Type)

Formato

Requerido

Informações Adicionais

(Adittional Information)


accounting_date	Data da Contabilização	string

Não há

	"dd/MM/yyyy"	Sim	Deve ser informado apenas data, sem a porção de horário.
cod_user	Código do usuário	string

Não há

	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.

allotment_numberNúmero do loteintegerNão há


standard_historic	Histórico padrão	string		Não

há

	Descrição do lançamento, máximo de 2.000 caracteres.
company_number	Número da empresa	integer

Não háprocess_number

	Sim	Deve fazer referência à uma empresa cadastrada na base de dados.
process_number	Número do

Número do

processo

string

Não há

		Não	Ignorar campo.
module	Módulo	string

Não

Ignorar campo.

Não há


managerial	Gerencial	string

Não há

["S", "N"]	Sim	Informa se o lançamento é gerencial: Sim ("N") ou Não ("N").
extemporaneous	Extemporâneo	string

Não há

["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

Não háaccountt_transactionsTransaçõesCollection of AccountTransactionPOSTV2DTO

"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.

Não há

_pageNo

Sem

Número da página

integer

Não

Ignorar campo.

Não há


_pageSize	Tamanho da página	integer

Não há

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{
  "accounting_date": "sample string 1",
  "cod_user": "sample string 2",
  "allotment_number": 3,
  "standard_historic": "sample string 4",
  "company_number": 5,
  "process_number": "sample string 6",
  "module": "sample string 7",
  "managerial": "sample string 8",
  "extemporaneous": "sample string 9",
  "extemporaneous_date": "sample string 10",
  "accountt_transactions": [
    {
      "account": "sample string 1",
      "type": "sample string 2",
      "value": 3.0,
      "full_historic": "sample string 4",
      "seq_account": 1,
      "account_transaction_params": [
        {
          "parameter": "sample string 1",
          "parameter_value": "sample string 2"
        },
        {
          "parameter": "sample string 1",
          "parameter_value": "sample string 2"
        }
      ]
    },
    {
      "account": "sample string 1",
      "type": "sample string 2",
      "value": 3.0,
      "full_historic": "sample string 4",
      "seq_account": 1,
      "account_transaction_params": [
        {
          "parameter": "sample string 1",
          "parameter_value": "sample string 2"
        },
        {
          "parameter": "sample string 1",
          "parameter_value": "sample string 2"
        }
      ]
    }
  ],
  "_pageNo": 11,
  "_pageSize": 12
}

application/xml, text/xml

Exemplo (Sample):

<AccountingEntryPOSTV2DTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities.Entities.v2.AccountingEntry">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities">11</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities">12</_pageSize>
  <ACCOUNTING_DATE>sample string 1</ACCOUNTING_DATE>
  <ACCOUNTT_TRANSACTIONS>
    <AccountTransactionPOSTV2DTO>
      <ACCOUNT>sample string 1</ACCOUNT>
      <ACCOUNT_TRANSACTION_PARAMS>
        <AccountTransactionParamPOSTV2DTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTV2DTO>
        <AccountTransactionParamPOSTV2DTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTV2DTO>
      </ACCOUNT_TRANSACTION_PARAMS>
      <FULL_HISTORIC>sample string 4</FULL_HISTORIC>
      <SEQ_ACCOUNT>1</SEQ_ACCOUNT>
      <TYPE>sample string 2</TYPE>
      <VALUE>3</VALUE>
    </AccountTransactionPOSTV2DTO>
    <AccountTransactionPOSTV2DTO>
      <ACCOUNT>sample string 1</ACCOUNT>
      <ACCOUNT_TRANSACTION_PARAMS>
        <AccountTransactionParamPOSTV2DTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTV2DTO>
        <AccountTransactionParamPOSTV2DTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTV2DTO>
      </ACCOUNT_TRANSACTION_PARAMS>
      <FULL_HISTORIC>sample string 4</FULL_HISTORIC>
      <SEQ_ACCOUNT>1</SEQ_ACCOUNT>
      <TYPE>sample string 2</TYPE>
      <VALUE>3</VALUE>
    </AccountTransactionPOSTV2DTO>
  </ACCOUNTT_TRANSACTIONS>
  <ALLOTMENT_NUMBER>3</ALLOTMENT_NUMBER>
  <COD_USER>sample string 2</COD_USER>
  <COMPANY_NUMBER>5</COMPANY_NUMBER>
  <EXTEMPORANEOUS>sample string 9</EXTEMPORANEOUS>
  <EXTEMPORANEOUS_DATE>sample string 10</EXTEMPORANEOUS_DATE>
  <MANAGERIAL>sample string 8</MANAGERIAL>
  <MODULE>sample string 7</MODULE>
  <PROCESS_NUMBER>sample string 6</PROCESS_NUMBER>
  <STANDARD_HISTORIC>sample string 4</STANDARD_HISTORIC>
</AccountingEntryPOSTV2DTO>

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

...

Código numérico sequencial do lote

...

Número do Lote

...

Código numérico sequencial do histórico (opcional)

...

Valor da Entrada

...

Código numérico sequencial padrão do histórico (opcional)

...

Histórico padrão

...

Número da empresa

...

Número do processo

...

Liquidação

...

Módulo

...

Quantidade da Transação

...

Código sequencial do Status

...

Valor “S” para extemporâneo: retorna apenas os registros extemporâneos da contabilização. Valor “N”: Todos os registros.

...

Retorna apenas os registros extemporâneos da contabilidade com data igual a informada.

...

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

Bloco de código

{
  "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",

...

Formatos da Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "seq_accounting_entry": 1,
    "accounting_date": "2020-04-01T13:53:58.4835319-03:00",
    "addition_date": "2020-04-01T13:53:58.4835319-03:00",
    "seq_allotment": 4,
    "allotment_number": 5,
    "seq_historic": 6,
    "value": 7.0,
    "seq_standard_historic": 8,
    "standard_historic": "sample string 9",
    "company_number": 10,
    "process_number": "sample string 11",
    "settlement": "sample string 12",
    "module": "sample string 13",
    "transaction_quantity": 14,
    "seq_status": "sample string 15",
    "extemporaneous": "sample string 16",
    "extemporaneous_date": "2020-04-01T13:53:58.4835319-03:00",
    "type": "sample string 17",
    "managerial": "sample string 18",
    "account_transactions": [
      {
        "seq_account_transaction": 1,
        "seq_account": 2,
        "account": "sample string 3",
        "type": "sample string 4",
        "value": 5.0,
        "account_transaction_parameters": [
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          },
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          }
        ]
      },
      {
        "seq_account_transaction": 1,
        "seq_account": 2,
        "account": "sample string 3",
        "type": "sample string 4",
        "value": 5.0,
        "account_transaction_parameters": [
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          },
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          }
        ]
      }
    ]
  },
  {
    "seq_accounting_entry": 1,
    "accounting_date": "2020-04-01T13:53:58.4835319-03:00",
    "addition_date": "2020-04-01T13:53:58.4835319-03:00",
    "seq_allotment": 4,
    "allotment_number": 5,
    "seq_historic": 6,
    "value": 7.0,
    "seq_standard_historic": 8,
    "standard_historic": "sample string 9",
    "company_number": 10,
    "process_number": "sample string 11",
    "settlement": "sample string 12",
    "module": "sample string 13",
    "transaction_quantity": 14,
    "seq_status": "sample string 15",
    "extemporaneous": "sample string 16",
    "extemporaneous_date": "2020-04-01T13:53:58.4835319-03:00",
    "type": "sample string 17",
    "managerial": "sample string 18",
    "account_transactions": [
      {
        "seq_account_transaction": 1,
        "seq_account": 2,
        "account": "sample string 3",
        "type": "sample string 4",
        "value": 5.0,
        "account_transaction_parameters": [
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          },
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          }
        ]
      },
      {
        "seq_account_transaction": 1,
        "seq_account": 2,
        "account": "sample string 3",
        "type": "sample string 4",
        "value": 5.0,
        "account_transaction_parameters": [
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          },
          {
            "seq_account_parameter": 1,
            "seq_parameter": "sample string 2",
            "parameter": "sample string 3",
            "ref_code": "sample string 4"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Exemplo (Sample):

...


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

application/json, text/json

Exemplo (Sample):

Bloco de código
{

...

"new_accounting_entry": 1571.0
}

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Chamada

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

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 Requisição (Request Formats)

Formatos da Resposta (Response Formats)

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Formatos da Resposta (Response Formats)