Árvore de páginas

Versões comparadas

Chave

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

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

Informações para

...

Requisição (Request Information)

Parâmetros

...

URI (URI Parameters)

Não Há.

Parâmetros do

...

Corpo (Body Parameters)

AccountingEntryPOSTDTO

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

Data da Contabilização

stringNão há
cod_userCódigo do usuáriostringNão há
allotment_numberNúmero do loteintegerNão há
standard_historicHistórico padrãostringNão há
company_numberNúmero da empresaintegerNão há
process_numberNúmero do processostring Não há
moduleMódulostring Não há
extemporaneousExtemporâneostring Não há
extemporaneous_dateData Extemporâneostring Não há
accountt_transactionsTransaçõesCollection of AccountTransactionPOSTDTO Não há
_pageNoSem páginainteger Não há
_pageSizeTamanho da páginainteger Não há

Formatos da

...

Requisição (Request Formats)

application/json, text/json

Exemplo 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",
  "extemporaneous": "sample string 8",
  "extemporaneous_date": "sample string 9",
  "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": 10,
  "_pageSize": 11
}

application/xml, text/xml

Exemplo Exemplo (Sample):

<AccountingEntryPOSTDTO 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">10</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Abaci.API.Entities">11</_pageSize>
  <ACCOUNTING_DATE>sample string 1</ACCOUNTING_DATE>
  <ACCOUNTT_TRANSACTIONS>
    <AccountTransactionPOSTDTO>
      <ACCOUNT>sample string 1</ACCOUNT>
      <ACCOUNT_TRANSACTION_PARAMS>
        <AccountTransactionParamPOSTDTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTDTO>
        <AccountTransactionParamPOSTDTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTDTO>
      </ACCOUNT_TRANSACTION_PARAMS>
      <FULL_HISTORIC>sample string 4</FULL_HISTORIC>
      <SEQ_ACCOUNT>1</SEQ_ACCOUNT>
      <TYPE>sample string 2</TYPE>
      <VALUE>3</VALUE>
    </AccountTransactionPOSTDTO>
    <AccountTransactionPOSTDTO>
      <ACCOUNT>sample string 1</ACCOUNT>
      <ACCOUNT_TRANSACTION_PARAMS>
        <AccountTransactionParamPOSTDTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTDTO>
        <AccountTransactionParamPOSTDTO>
          <PARAMETER>sample string 1</PARAMETER>
          <PARAMETER_VALUE>sample string 2</PARAMETER_VALUE>
        </AccountTransactionParamPOSTDTO>
      </ACCOUNT_TRANSACTION_PARAMS>
      <FULL_HISTORIC>sample string 4</FULL_HISTORIC>
      <SEQ_ACCOUNT>1</SEQ_ACCOUNT>
      <TYPE>sample string 2</TYPE>
      <VALUE>3</VALUE>
    </AccountTransactionPOSTDTO>
  </ACCOUNTT_TRANSACTIONS>
  <ALLOTMENT_NUMBER>3</ALLOTMENT_NUMBER>
  <COD_USER>sample string 2</COD_USER>
  <COMPANY_NUMBER>5</COMPANY_NUMBER>
  <EXTEMPORANEOUS>sample string 8</EXTEMPORANEOUS>
  <EXTEMPORANEOUS_DATE>sample string 9</EXTEMPORANEOUS_DATE>
  <MODULE>sample string 7</MODULE>
  <PROCESS_NUMBER>sample string 6</PROCESS_NUMBER>
  <STANDARD_HISTORIC>sample string 4</STANDARD_HISTORIC>
</AccountingEntryPOSTDTO>

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 
Nome (Name)
Descrição 
Descrição (Description)
Tipo 
Tipo (Type)Informações
Adicionais 
Adicionais (Adittional Information)
seq_accounting_entryCódigo numérico sequencial do registrointegerNão há
accounting_dateData da ContabilizaçãodateNã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_transactions
Collection of AccountTransactionDTONão há.

Formatos da

...

Resposta (Response Formats)

application/json, text/json

Exemplo Exemplo (Sample):

[
  {
    "seq_accounting_entry": 1,
    "accounting_date": "2020-04-01T10:03:08.4654084-03:00",
    "addition_date": "2020-04-01T10:03:08.4654084-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:03:08.4654084-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:03:08.4654084-03:00",
    "addition_date": "2020-04-01T10:03:08.4654084-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:03:08.4654084-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 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:03:08.4654084-03:00</ACCOUNTING_DATE>
    <ADDITION_DATE>2020-04-01T10:03:08.4654084-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:03:08.4654084-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:03:08.4654084-03:00</ACCOUNTING_DATE>
    <ADDITION_DATE>2020-04-01T10:03:08.4654084-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:03:08.4654084-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>