Árvore de páginas

Objetivo

A finalidade deste método é possibilitar o retorno de informações de lançamentos de entrada da contabilidade por meio de um método do tipo POST.

Chamada

POST api/v3/abaci/returnaccountingentry

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

AccountingEntryGETV3DTO

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

Código numérico sequencial do registro

integerNão há
accounting_dateData da ContabilizaçãostringNão há
allotment_numberNúmero do loteintegerNão há
valueValordecimal numberNão há
standard_historic Histórico padrãostringNão há
company_number Número da empresaintegerNão há
process_numberNúmero do processostringNão há
settlementLiquidaçãostringNão há
accountContastringNão há
typeTipostringNão há
statusStatusstringNão há
extemporaneousExtemporaneostringNão há
extemporaneous_dateData ExtemporaneostringNão há
parameterParâmetrostringNão há
parameter_valueValor do ParâmetrostringNão há
managerialGerencialstringNão há
num_document
Número do DocumentointegerNão há
_pageNoSem páginaintegerNão há
_pageSizeTamanho da páginaintegerNão há

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{"seq_accounting_entry": 0,
"accounting_date": "2021-01-25T13:56:47.606Z",
"addition_date": "2021-01-25T13:56:47.606Z",
"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.606Z",
"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"?>
<AccountingEntryResponceV3DTO>
<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>
</AccountingEntryResponceV3DTO>

application/x-www-form-urlencoded

Exemplo (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

AccountingEntryV3DTO

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

integerNão há.
accounting_date

Data da Contabilização

dateNão há.
addition_dateData da InclusãodateNão há.
seq_allotment

Código numérico sequencial do lote

integerNão há.
allotment_number

Número do Lote

integerNão há.
seq_historic

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

integerNão há.
value

Valor da Entrada

decimal numberNão há.
seq_standard_historic

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

integerNão há.
standard_historic

Histórico padrão

stringNão há.
company_number

Número da empresa

integerNão há.
process_number

Número do processo

stringNão há.
settlement

Liquidação

stringNão há.
module

Módulo

stringNão há.
transaction_quantity

Quantidade da Transação

integerNão há.
seq_status

Código sequencial do Status

stringNão há.
extemporaneous

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

stringNão há.
extemporaneous_date

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

dateNão há.
num_document
Número de documentointegerNão há.
typetipostringNão há.
managerialGerencialstringNão há
account_transactionstransaçõesCollection of AccountTransactionV3DTONão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "seq_accounting_entry": 1,
    "accounting_date": "2020-04-01T13:46:01.0059984-03:00",
    "addition_date": "2020-04-01T13:46:01.0059984-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:46:01.0059984-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,
"num_document": 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,
"num_document": 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:46:01.0059984-03:00", "addition_date": "2020-04-01T13:46:01.0059984-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:46:01.0059984-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,
"num_document": 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,
"num_document": 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):

<ArrayOfAccountingEntryResponceV3DTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities.Entities.v3.AccountingEntry">
  <AccountingEntryResponceV3DTO>
<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>
</AccountingEntryResponceV3DTO>