Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Parâmetros do Corpo (Body Parameters)

AccountingEntryPOSTV3DTO

Nome
(Name)
Descrição
(Description)
Tipo
(Type)
FormatoRequeridoInformações Adicionais
(Adittional Information)
accounting_date

Data da Contabilização

string
Não há
"dd/MM/yyyy"SimDeve ser informado apenas data, sem a porção de horário.
cod_userCódigo do usuáriostring

SimCódigo do usuário, o mesmo informado para realizar o login no ambiente web.
Não há
allotment_numberNúmero do loteinteger
Não há

SimDeve fazer referência à um lote cadastrado na base de dados.
standard_historicHistórico padrãostring
Não
Descrição do lançamento, máximo de 2.000 caracteres.
company_numberNúmero da empresainteger
Não há

SimDeve fazer referência à uma empresa cadastrada na base de dados.
process_numberNúmero do processostring
 Não há

NãoIgnorar campo.
moduleMódulostring
 Não há

NãoIgnorar campo.
managerialGerencialstring["S", "N"]
Não há
SimInforma se o lançamento é gerencial: Sim ("N") ou Não ("N").
extemporaneousExtemporâneostring
["S", "N"]NãoInforma se o lançamento é extemporâneo: Sim ("N") ou Não ("N"). Se não for informado, toma o valor "N" como padrão.
 Não há
extemporaneous_dateData Extemporâneostring
"dd/MM/yyyy"NãoSe extemporaneous for informado como "S", esse campo passa a ser requerido.
 Não há
accountt_transactions
TransaçõesCollection of AccountTransactionPOSTV3DTO Não há
Partidas do LançamentoList<AccountTransactionPOSTV3DTO>
SimRepresenta as partidas do lançamento.
_pageNoNúmero da página
num_document
Número de documento
integer
Não
_pageNoSem páginainteger Não há
Ignorar campo.
_pageSizeTamanho da páginainteger
 Não há

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

...

application/xml, text/xml

Exemplo (Sample):

...


NãoIgnorar campo.


AccountTransactionPOSTV3DTO

NomeDescriçãoTipoFormatoRequeridoInformações Adicionais
account

Conta Contábil

string["1.0.0.0.13", "100013", "123" ]SimDeve ser informado o número da conta contábil. com ou sem a pontuação, ou então o código reduzido da mesma.
typeTipo da partidastring["D", "C"]SimInforma se a partida é débito ("D") ou crédito ("C").
valueValordecimal1234.56SimValor deve ser positivo.
full_historicHistórico Completostring
NãoDescrição da partida. Máximo de 2000 caracteres.
seq_accountSequencial da Conta Contábillong
NãoPode 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_documentNúmero de Documentolong
NãoCampo opcional para caso o usuário deseje adicionar lastro em cada partida.
account_transaction_paramsParâmetros da PartidaList<AccountTransactionParamV3POSTDTO>
SimRepresenta os parâmetros da partida.


AccountTransactionParamV3POSTDTO

NomeDescriçãoTipoFormatoRequeridoInformaçõ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_valueValor do Parâmetrostring
SimCódigo da entidade informada.

Formatos da Requisição (Request

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.

...

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

...


          "parameter_value": "

...

application/xml, text/xml

Exemplo (Sample):

...

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)


NomeDescriçãoTipoInformações Adicionais
new_accounting_entryCódigo numérico sequencial do registro que acabou de ser inserido.doubleNão há

Formatos da Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

Bloco de código
{
    "new_accounting_entry": 1571.0
}