Á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/v1/abaci/returnaccountingentry

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

AccountingEntryGETDTO

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á
_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": 1,
  "accounting_date": "sample string 1",
  "allotment_number": 1,
  "value": 1.0,
  "standard_historic": "sample string 2",
  "company_number": 1,
  "process_number": "sample string 3",
  "settlement": "sample string 4",
  "account": "sample string 5",
  "type": "sample string 6",
  "status": "sample string 7",
  "extemporaneous": "sample string 8",
  "extemporaneous_date": "sample string 9",
  "parameter": "sample string 10",
  "parameter_value": "sample string 11",
  "_pageNo": 12,
  "_pageSize": 13
}

application/xml, text/xml

Exemplo (Sample):

<AccountingEntryGETDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities.Entities.v1.AccountingEntry">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities">12</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities">13</_pageSize>
  <ACCOUNT>sample string 5</ACCOUNT>
  <ACCOUNTING_DATE>sample string 1</ACCOUNTING_DATE>
  <ALLOTMENT_NUMBER>1</ALLOTMENT_NUMBER>
  <COMPANY_NUMBER>1</COMPANY_NUMBER>
  <EXTEMPORANEOUS>sample string 8</EXTEMPORANEOUS>
  <EXTEMPORANEOUS_DATE>sample string 9</EXTEMPORANEOUS_DATE>
  <PARAMETER>sample string 10</PARAMETER>
  <PARAMETER_VALUE>sample string 11</PARAMETER_VALUE>
  <PROCESS_NUMBER>sample string 3</PROCESS_NUMBER>
  <SEQ_ACCOUNT>1</SEQ_ACCOUNT>
  <SEQ_ACCOUNTING_ENTRY>1</SEQ_ACCOUNTING_ENTRY>
  <SEQ_ALLOTMENT>1</SEQ_ALLOTMENT>
  <SEQ_STANDARD_HISTORIC>1</SEQ_STANDARD_HISTORIC>
  <SETTLEMENT>sample string 4</SETTLEMENT>
  <STANDARD_HISTORIC>sample string 2</STANDARD_HISTORIC>
  <STATUS>sample string 7</STATUS>
  <TYPE>sample string 6</TYPE>
  <VALUE>1</VALUE>
</AccountingEntryGETDTO>

application/x-www-form-urlencoded

Exemplo (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

AccountingEntryDTO

Collection of AccountingEntryResponceDTO

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á.
typetipostringNão há.
account_transactionstransaçõesCollection of AccountTransactionDTONão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "seq_accounting_entry": 1,
    "accounting_date": "2020-04-01T10:30:16.3376418-03:00",
    "addition_date": "2020-04-01T10:30:16.3376418-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-01T10:30:16.3376418-03:00",
    "type": "sample string 17",
    "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-01T10:30:16.3376418-03:00",
    "addition_date": "2020-04-01T10:30:16.3376418-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-01T10:30:16.3376418-03:00",
    "type": "sample string 17",
    "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):

<ArrayOfAccountingEntryResponceDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities.Entities.v1.AccountingEntry">
  <AccountingEntryResponceDTO>
    <ACCOUNTING_DATE>2020-04-01T10:30:16.3376418-03:00</ACCOUNTING_DATE>
    <ADDITION_DATE>2020-04-01T10:30:16.3376418-03:00</ADDITION_DATE>
    <ALLOTMENT_NUMBER>5</ALLOTMENT_NUMBER>
    <AccountTransactions>
      <AccountTransactionDTO>
        <ACCOUNT>sample string 3</ACCOUNT>
        <AccountTransactionParameters>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
        </AccountTransactionParameters>
        <SEQ_ACCOUNT>2</SEQ_ACCOUNT>
        <SEQ_ACCOUNT_TRANSACTION>1</SEQ_ACCOUNT_TRANSACTION>
        <TYPE>sample string 4</TYPE>
        <VALUE>5</VALUE>
      </AccountTransactionDTO>
      <AccountTransactionDTO>
        <ACCOUNT>sample string 3</ACCOUNT>
        <AccountTransactionParameters>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
        </AccountTransactionParameters>
        <SEQ_ACCOUNT>2</SEQ_ACCOUNT>
        <SEQ_ACCOUNT_TRANSACTION>1</SEQ_ACCOUNT_TRANSACTION>
        <TYPE>sample string 4</TYPE>
        <VALUE>5</VALUE>
      </AccountTransactionDTO>
    </AccountTransactions>
    <COMPANY_NUMBER>10</COMPANY_NUMBER>
    <EXTEMPORANEOUS>sample string 16</EXTEMPORANEOUS>
    <EXTEMPORANEOUS_DATE>2020-04-01T10:30:16.3376418-03:00</EXTEMPORANEOUS_DATE>
    <MODULE>sample string 13</MODULE>
    <PROCESS_NUMBER>sample string 11</PROCESS_NUMBER>
    <SEQ_ACCOUNTING_ENTRY>1</SEQ_ACCOUNTING_ENTRY>
    <SEQ_ALLOTMENT>4</SEQ_ALLOTMENT>
    <SEQ_HISTORIC>6</SEQ_HISTORIC>
    <SEQ_STANDARD_HISTORIC>8</SEQ_STANDARD_HISTORIC>
    <SEQ_STATUS>sample string 15</SEQ_STATUS>
    <SETTLEMENT>sample string 12</SETTLEMENT>
    <STANDARD_HISTORIC>sample string 9</STANDARD_HISTORIC>
    <TRANSACTION_QUANTITY>14</TRANSACTION_QUANTITY>
    <TYPE>sample string 17</TYPE>
    <VALUE>7</VALUE>
  </AccountingEntryResponceDTO>
  <AccountingEntryResponceDTO>
    <ACCOUNTING_DATE>2020-04-01T10:30:16.3376418-03:00</ACCOUNTING_DATE>
    <ADDITION_DATE>2020-04-01T10:30:16.3376418-03:00</ADDITION_DATE>
    <ALLOTMENT_NUMBER>5</ALLOTMENT_NUMBER>
    <AccountTransactions>
      <AccountTransactionDTO>
        <ACCOUNT>sample string 3</ACCOUNT>
        <AccountTransactionParameters>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
        </AccountTransactionParameters>
        <SEQ_ACCOUNT>2</SEQ_ACCOUNT>
        <SEQ_ACCOUNT_TRANSACTION>1</SEQ_ACCOUNT_TRANSACTION>
        <TYPE>sample string 4</TYPE>
        <VALUE>5</VALUE>
      </AccountTransactionDTO>
      <AccountTransactionDTO>
        <ACCOUNT>sample string 3</ACCOUNT>
        <AccountTransactionParameters>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
          <AccountTransactionParameterDTO>
            <PARAMETER>sample string 3</PARAMETER>
            <REF_CODE>sample string 4</REF_CODE>
            <SEQ_ACCOUNT_PARAMETER>1</SEQ_ACCOUNT_PARAMETER>
            <SEQ_PARAMETER>sample string 2</SEQ_PARAMETER>
          </AccountTransactionParameterDTO>
        </AccountTransactionParameters>
        <SEQ_ACCOUNT>2</SEQ_ACCOUNT>
        <SEQ_ACCOUNT_TRANSACTION>1</SEQ_ACCOUNT_TRANSACTION>
        <TYPE>sample string 4</TYPE>
        <VALUE>5</VALUE>
      </AccountTransactionDTO>
    </AccountTransactions>
    <COMPANY_NUMBER>10</COMPANY_NUMBER>
    <EXTEMPORANEOUS>sample string 16</EXTEMPORANEOUS>
    <EXTEMPORANEOUS_DATE>2020-04-01T10:30:16.3376418-03:00</EXTEMPORANEOUS_DATE>
    <MODULE>sample string 13</MODULE>
    <PROCESS_NUMBER>sample string 11</PROCESS_NUMBER>
    <SEQ_ACCOUNTING_ENTRY>1</SEQ_ACCOUNTING_ENTRY>
    <SEQ_ALLOTMENT>4</SEQ_ALLOTMENT>
    <SEQ_HISTORIC>6</SEQ_HISTORIC>
    <SEQ_STANDARD_HISTORIC>8</SEQ_STANDARD_HISTORIC>
    <SEQ_STATUS>sample string 15</SEQ_STATUS>
    <SETTLEMENT>sample string 12</SETTLEMENT>
    <STANDARD_HISTORIC>sample string 9</STANDARD_HISTORIC>
    <TRANSACTION_QUANTITY>14</TRANSACTION_QUANTITY>
    <TYPE>sample string 17</TYPE>
    <VALUE>7</VALUE>
  </AccountingEntryResponceDTO>
</ArrayOfAccountingEntryResponceDTO>