...

Informações

icon	false
title	GetAll

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "operationId": 0,
            "reversal": false,
            "companyId": 6,
            "entryId": 9,
            "batchCode": 0,
            "description": "GAS",
            "accountEntry": [
                {
                    "companyId": 6,
                    "batchCode": 0,
                    "entryId": 9,
                    "entryNumberId": 8,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2011-09-15T00:00:00-03:00",
                    "dateInclusion": "2017-09-15T11:44:42-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.892",
                    "debitDescription": "COLIG. 6 FILIAL 12",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.002",
                    "creditDescription": "Caixa Filial Rio de Janeiro",
                    "companyIdAgainstEntry": 0,
                    "value": 111.00,
                    "value2": 200.00,
                    "date2": "2011-09-15T00:00:00-03:00",
                    "integrateApplication": "C",
                    "originNewMod": 1,
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 8,
                        "idpartida": 8,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                }
            ]
        },
        {
            "operationId": 0,
            "reversal": false,
            "companyId": 6,
            "entryId": 10,
            "batchCode": 0,
            "description": "BLOCO K",
            "accountEntry": [
                {
                    "companyIdentryNumberId": 69,
                    "batchCodebranchId": 012,
                    "entryIdbranchName": 10 "ESCOLA EXEMPLO 1",
                    "entryNumberId": 9,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2017-04-11T00:00:00date": "2017-04-11T00:00:00-03:00",
                    "dateInclusion": "2018-04-11T16:01:07-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.017",
                    "debitDescription": "BLOCO K 200 D",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "2.1.1.1.015",
                    "creditDescription": "200,00 C",
                    "companyIdAgainstEntry": 0,
                    "value": 200.00,
                    "value2": 400.00,
                    "date2": "2017-04-11T00:00:00-03:00",
                    "historicCode": "011",
                    "integrateApplication": "C",
                    "originNewMod": 1,
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 9,
                        "idpartida": 9,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                }
            ]
        }
      ]
}

2.1.2 - Order (Retorna os dados ordenados)

...

Informações

icon	false
title	Order (Asc)

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?order={campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: description

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?order=description

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "idreversal": "14|00002"false,
            "companycompanyId": 146,
            "codeentryId": "00002"10,
            "descriptionbatchCode": "00002"0,
            "instantBalancedescription": 0.0000 "BLOCO K",
            "databaseBalanceaccountEntry": 0.0000,
[
              "cashAccountDatabase": "2020-02-19T00:00:00-03:00",  {
            "proprietaryCompany        "entryNumberId": 149,
                    "unpaidBalancebranchId": -57378.940012,
                    "currencyCodebranchName": "R$ESCOLA EXEMPLO 1",
                    "activedate": 1"2017-04-11T00:00:00-03:00",
            "cashBookCode        "dateInclusion": "8882018-04-11T16:01:07-03:00",
            "allowOpenning": 0
       "companyIdDebitAccount": }6,
        {
            "iddebitAccount": "1|00051.1.1.1.017",
            "company": 1,
            "codedebitDescription": "0005BLOCO K 200 D",
            "description": "APLICACAO BANCO REAL",
     "companyIdCreditAccount": 6,
      "instantBalance": 16620.0000,
              "databaseBalancecreditAccount": 120.0000"2.1.1.1.015",
            "cashAccountDatabase": "1999-12-15T00:00:00-03:00",
        "creditDescription": "200,00 C",
                    "proprietaryCompanycompanyIdAgainstEntry": 60,
              "bankNumber      "value": "275"200.00,
                    "agencyNumbervalue2": "002233"400.00,
            "accountNumber        "date2": "222002017-04-11T00:00:00-03:00",
            "unpaidBalance": 0.0000,
            "currencyCodehistoricCode": "R$011",
            "active": 1,
            "lastCashNumberintegrateApplication": "1C",
            "allowOpenning": 1
        }"generationType": "O",
        {
            "iduser": "1|0066mestre",
            "company": 1,
            "codecomplementaryFields": "0066",{
            "description": "BANCO BEMGE",
            "instantBalancecodlote": 200000.00000,
            "databaseBalance": 200000.0000,
            "cashAccountDatabaselctref": "2015-01-09T00:00:00-03:00"9,
            "proprietaryCompany": 1,
            "unpaidBalanceidpartida": 0.00009,
            "currencyCode": "R$",
            "activeidinteiro": 1,
0
                  "branchCode": 1  },
            "allowOpenning": 0
       "batchCodeOrigin": }0,
        {
            "iduserModified": "1|0009mestre",
            "company        "operationId": 10,
            "code": "0009",
       "reversalAccountId": 0,
    "description": "BANCO BRADESCO",
                "instantBalancegroupAccountId": 65155.25000,
            "databaseBalance": 100000.0000,
            "cashAccountDatabaseaccountId": "2004-11-03T00:00:00-03:00"0,
            "proprietaryCompany": 1,
            "bankNumberitemAmountRAS": "237"0,
            "agencyNumber        "apportionmentDebit": "0065"[],
                    "accountNumberapportionmentCredit": "0019284"[],
                    "unpaidBalancevaluesCurrencies": 0.0000[],
                    "currencyCodeapportionmentValuesCurrencies": "R$",
[]
               "active": 1, }
            "allowOpenning": 0]
        },
        {
            "idreversal": "1|0008"false,
            "companycompanyId": 16,
            "codeentryId": "0008"11,
            "descriptionbatchCode": "BANCO DO BRASIL"0,
            "instantBalancedescription": 203690.1300 "BLOCO K",
            "databaseBalanceaccountEntry": 0.0000,[
            "cashAccountDatabase": "2004-09-14T00:00:00-03:00",
   {
         "proprietaryCompany": 1,
            "bankNumberentryNumberId": "001"10,
            "agencyNumber": "3489",
            "accountNumberbranchId": "14714"12,
            "unpaidBalance": 15500.0000,
        "branchName": "ESCOLA EXEMPLO 1",
                    "currencyCodedate": "R$2017-04-11T00:00:00-03:00",
                    "activedateInclusion": 1"2018-04-11T17:06:56-03:00",
            "allowOpenning        "companyIdDebitAccount": 06,
        }
            "debitAccount": "2.1.1.1.016",
        ]
}

Informações

icon	false
title	Order (Desc)

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?order=[-]{campo}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: description

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?order=-description

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

   {
    "hasNext": false,
    "items": [            "debitDescription": "585,76 D",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.018",
        {
            "operationIdcreditDescription": 0"585,76 C",
            "reversal": false,
            "companyIdcompanyIdAgainstEntry": 60,
            "entryId": 9,
            "batchCodevalue": 0585.76,
            "description": "GAS",
       "value2": 1171.52,
    "accountEntry": [
                {"date2": "2017-04-11T00:00:00-03:00",
                    "companyIdintegrateApplication": 6"C",
                    "batchCodegenerationType": 0"O",
                    "entryIduser": 9"mestre",
                    "entryNumberIdcomplementaryFields": 8,{
                        "branchIdcodlote": 120,
                        "branchNamelctref": "ESCOLA EXEMPLO 1",
 10,
                        "dateidpartida": "2011-09-15T00:00:00-03:00"10,
                        "dateInclusionidinteiro": "2017-09-15T11:44:42-03:00",0
                    "companyIdDebitAccount": 6},
                    "debitAccountbatchCodeOrigin": "1.1.1.1.892"0,
                    "debitDescriptionuserModified": "COLIG. 6 FILIAL 12mestre",
                    "companyIdCreditAccountoperationId": 60,
                    "creditAccountreversalAccountId": "1.1.1.1.002"0,
                    "creditDescriptiongroupAccountId": "Caixa Filial Rio de Janeiro"0,
                    "companyIdAgainstEntryaccountId": 0,
                    "valueitemAmountRAS": 111.000,
                    "value2apportionmentDebit": 200.00[],
                    "date2apportionmentCredit": "2011-09-15T00:00:00-03:00"[],
                    "integrateApplicationvaluesCurrencies": "C"[],
                    "originNewModapportionmentValuesCurrencies": 1,[]
                },
    "generationType": "O",            {
                    "userentryNumberId": "mestre"11,
                    "complementaryFieldsbranchId": {12,
                    "branchName": "ESCOLA EXEMPLO  1"codlote": 0,
                        "lctrefdate": 8"2017-04-11T00:00:00-03:00",
                        "idpartidadateInclusion": 8"2018-04-11T18:10:39-03:00",
                        "idinteirocompanyIdDebitAccount": 06,
                    }"debitAccount": "2.1.1.1.017",
                    "batchCodeOrigindebitDescription": 0 "1122,12 D",
                    "userModifiedcompanyIdCreditAccount": "mestre"6,
                    "operationIdcreditAccount": 0"1.1.1.1.019",
                    "reversalAccountIdcreditDescription": 0 "1122,12 C",
                    "groupAccountIdcompanyIdAgainstEntry": 0,
                    "accountIdvalue": 01122.12,
                    "itemAmountRASvalue2": 02244.24,
                    "apportionmentDebitdate2": []"2017-04-11T00:00:00-03:00",
                    "apportionmentCreditintegrateApplication": []"C",
                    "valuesCurrenciesgenerationType": []"O",
                    "apportionmentValuesCurrenciesuser": []"mestre",
                }
            ]"complementaryFields": {
        },
        {
            "operationIdcodlote": 0,
            "reversal": false,
            "companyIdlctref": 611,
            "entryId": 12,
            "batchCodeidpartida": 011,
            "description": "EQUIVALENCIA - AUTOMAÇÃO",
            "accountEntryidinteiro": [0
                {    },
                    "companyIdbatchCodeOrigin": 60,
                    "batchCodeuserModified": 0"mestre",
                    "entryIdoperationId": 120,
                    "entryNumberIdreversalAccountId": 140,
                    "branchIdgroupAccountId": 120,
                    "branchNameaccountId": "ESCOLA EXEMPLO 1"0,
                    "dateitemAmountRAS": "2011-05-07T00:00:00-03:00"0,
                    "dateInclusionapportionmentDebit": "2019-09-12T11:31:48-03:00"[],
                    "companyIdDebitAccountapportionmentCredit": 6[],
                    "debitAccountvaluesCurrencies": "1.1.1.1.001"[],
                    "debitDescriptionapportionmentValuesCurrencies": "Caixa Geral",[]
                    "companyIdCreditAccount": 6},
                    "creditAccount": "4.1.1.1.001",{
                    "creditDescriptionentryNumberId": "Vendas de Sistemas de Contabilidade"12,
                    "companyIdAgainstEntrybranchId": 012,
                    "valuebranchName": 500000.00"ESCOLA EXEMPLO 1",
                    "value2date": 1000000.00"2017-04-11T00:00:00-03:00",
                    "date2dateInclusion": "20112018-0504-07T0011T18:0026:0003-03:00",
                    "integrateApplicationcompanyIdDebitAccount": "C"6,
                    "originNewModdebitAccount": "1.1.1.1.020",
                    "generationTypedebitDescription": "O6,00 D",
                    "usercompanyIdCreditAccount": "mestre"6,
                    "complementaryFieldscreditAccount": {
    "2.1.1.1.018",
                    "codlotecreditDescription": 0 "6,00 C",
                        "lctrefcompanyIdAgainstEntry": 140,
                        "idpartidavalue": 146.00,
                        "idinteirovalue2": 012.00,
                    } "date2": "2017-04-11T00:00:00-03:00",
                    "batchCodeOriginhistoricCode": 0"011",
                    "operationIdintegrateApplication": 0"C",
                    "reversalAccountIdgenerationType": 0"O",
                    "groupAccountIduser": 0"mestre",
                    "accountIdcomplementaryFields": 0,{
                        "itemAmountRAScodlote": 0,
                        "apportionmentDebitlctref": []12,
                        "apportionmentCreditidpartida": []12,
                        "valuesCurrenciesidinteiro": [],0
                    "apportionmentValuesCurrencies": []
},
                    "batchCodeOrigin": }0,
                    { "userModified": "mestre",
                    "companyIdoperationId": 60,
                    "batchCodereversalAccountId": 0,
                    "entryIdgroupAccountId": 120,
                    "entryNumberIdaccountId": 150,
                    "branchIditemAmountRAS": 120,
                    "branchNameapportionmentDebit": "ESCOLA EXEMPLO 1"[],
                    "dateapportionmentCredit": "2011-05-07T00:00:00-03:00"[],
                    "dateInclusionvaluesCurrencies": "2019-09-12T11:31:48-03:00"[],
                    "companyIdDebitAccountapportionmentValuesCurrencies": 6,[]
                    "debitAccount": "3.1.1.3.001"},
                    "debitDescription": "DESPESAS FINANCEIRAS",{
                    "companyIdCreditAccountentryNumberId": 613,
                    "creditAccountbranchId": "1.1.1.1.001"12,
                    "creditDescriptionbranchName": "CaixaESCOLA EXEMPLO Geral1",
                    "companyIdAgainstEntrydate": 0"2017-04-11T00:00:00-03:00",
                    "valuedateInclusion": 250000.00"2018-04-11T18:36:57-03:00",
                    "value2companyIdDebitAccount": 500000.006,
                    "date2debitAccount": "2011-05-07T00:00:00-03:002.1.1.1.019",
                    "integrateApplicationdebitDescription": "C256,00 D",
                    "originNewModcompanyIdCreditAccount": 16,
                    "generationTypecreditAccount": "O1.1.1.1.021",
                    "usercreditDescription": "mestre256,00 C",
                    "complementaryFieldscompanyIdAgainstEntry": {0,
                        "codlotevalue": 0256.00,
                        "lctrefvalue2": 15512.00,
                        "idpartidadate2": 15"2017-04-11T00:00:00-03:00",
                        "idinteirointegrateApplication": 0"C",
                    } "generationType": "O",
                    "batchCodeOriginuser": 0"mestre",
                    "operationIdcomplementaryFields": 0,{
                        "reversalAccountIdcodlote": 0,
                        "groupAccountIdlctref": 013,
                        "accountIdidpartida": 013,
                        "itemAmountRASidinteiro": 0,
                    "apportionmentDebit": []},
                    "batchCodeOrigin": 0,
                    "apportionmentCredituserModified": []"mestre",
                    "valuesCurrenciesoperationId": []0,
                    "apportionmentValuesCurrenciesreversalAccountId": []
0,
                     }
"groupAccountId": 0,
                     ]
"accountId": 0,
                } 
	]
}

2.1.3 - Filter (Resultado filtrado)

    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                }
            ]
        }
     ]
}

Informações

icon	false
title	Order (Desc)

Máscara de Url: http:

Informações

icon	false
title	Filter

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?order=[-]{campo}={valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo:entryId descriptionValor

Tipo de Ordenação:9 Descendente

Url Utilizada:http://localhost:8051/api/ctb/v1/AccountingEntries/6?entryIdorder=9-description

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

   {
    "hasNext": false,
    "items": [
        {
            "operationId": 0,
            "reversal": false,
            "companyId": 6,
            "entryId": 920,
            "batchCode": 0,
            "description": "GAS 2",
            "accountEntry": [
                {
                    "companyIdentryNumberId": 623,
                    "batchCodebranchId": 012,
                    "entryIdbranchName": 9"ESCOLA EXEMPLO 1",
                    "entryNumberIddate": 8,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": ""2011-09-15T00:00:00-03:00",
                    "dateInclusion": "2017-09-15T11:44:42-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.892",
                    "debitDescription": "COLIG. 6 FILIAL 12",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.002",
                    "creditDescription": "Caixa Filial Rio de Janeiro",
                    "companyIdAgainstEntry": 0,
                    "value": 111.00,
                    "value2": 200.00,
                    "date2": "2011-09-15T00:00:00-03:00",
                    "integrateApplication": "C",
                    "originNewMod": 1,
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 821,
                        "idpartida": 823,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModifiedoperationId": "mestre"0,
                    "operationIdreversalAccountId": 0,
                    "reversalAccountIdgroupAccountId": 0,
                    "groupAccountIdaccountId": 0,
                    "accountIditemAmountRAS": 0,
                    "itemAmountRASapportionmentDebit": 0[],
                    "apportionmentDebitapportionmentCredit": [],
                    "apportionmentCreditvaluesCurrencies": [],
                    "valuesCurrenciesapportionmentValuesCurrencies": [],
                }
     "apportionmentValuesCurrencies": [       ]
        },
        }{
            ] "reversal": false,
        }
    ]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API de Lançamento e Partida é possível adotar o padrão OData. Para entender melhor sobre a utilização desse padrão, acesse o link da documentação Utilizando filtros complexos - Exemplos do guia de API - ODATA.

2.1.4 - Paginação

Informações

title	Parâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

"companyId": 6,
            "entryId": 22,
            "batchCode": 0,
            "description": "GAS 2",
            "accountEntry": [
                {
                    "entryNumberId": 25,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2011-09-15T00:00:00-03:00",
                    "dateInclusion": "2017-09-15T11:44:42-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.892",
                    "debitDescription": "COLIG. 6 FILIAL 12",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.002",
                    "creditDescription": "Caixa Filial Rio de Janeiro",
                    "companyIdAgainstEntry": 0,
                    "value": 111.00,
                    "value2": 200.00,
                    "date2": "2011-09-15T00:00:00-03:00",
                    "integrateApplication": "C",
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 23,
                        "idpartida": 25,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                }
            ]
        }
  ]
}

2.1.3 - Filter (Resultado filtrado)

...

Informações

icon	false
title	Filter

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?{campo}={valor}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: entryId

Valor: 9

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?entryId=9

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "reversal": false,
            "companyId": 6,
            "entryId": 9,
            "batchCode": 0,
            "description": "GAS",
            "accountEntry": [
                {
                    "entryNumberId": 8,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2011-09-15T00:00:00-03:00",
                    "dateInclusion": "2017-09-15T11:44:42-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.892",
                    "debitDescription": "COLIG. 6 FILIAL 12",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.002",
                    "creditDescription": "Caixa Filial Rio de Janeiro",
                    "companyIdAgainstEntry": 0,
                    "value": 111.00,
                    "value2": 200.00,
                    "date2": "2011-09-15T00:00:00-03:00",
                    "integrateApplication": "C",
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 8,
                        "idpartida": 8,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                }
            ]
        }
    ]
}

Informações

title	Filtros Complexos - OData

Para realizar filtros complexos na API de Lançamento e Partida é possível adotar o padrão OData. Para entender melhor sobre a utilização desse padrão, acesse o link da documentação Utilizando filtros complexos - Exemplos do guia de API - ODATA.

2.1.4 - Paginação

...

Informações

title	Parâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações

icon	false
title	Paginação

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?page={valor1}&pageSize={valor2}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 3

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?page=1&pageSize=3

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "reversal": false,
            "companyId": 6,
            "entryId": 9,
            "batchCode": 0,
            "description": "GAS",
            "accountEntry": [
                {
                    "entryNumberId": 8,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2011-09-15T00:00:00-03:00",
                    "dateInclusion": "2017-09-15T11:44:42-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "1.1.1.1.892",
                    "debitDescription": "COLIG. 6 FILIAL 12",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.002",
                    "creditDescription": "Caixa Filial Rio de Janeiro",
                    "companyIdAgainstEntry": 0,
                    "value": 111.00,
                    "value2": 200.00,
                    "date2": "2011-09-15T00:00:00-03:00",
                    "integrateApplication": "C",

Informações

icon	false
title	Paginação

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?page={valor1}&pageSize={valor2}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 3

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?page=1&pageSize=3

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "items": [
        {
            "operationIdgenerationType": 0"O",
            "reversal        "user": false"mestre",
            "companyId": 6,
            "entryIdcomplementaryFields": 9,{
            "batchCode": 0,
            "descriptioncodlote": "GAS"0,
            "accountEntry": [
           "lctref": 8,
    {
                    "companyIdidpartida": 68,
                        "batchCodeidinteiro": 0,
                    "entryId": 9},
                    "entryNumberIdbatchCodeOrigin": 80,
                    "branchIduserModified": 12"mestre",
                    "branchNameoperationId": "ESCOLA EXEMPLO 1"0,
                    "datereversalAccountId": "2011-09-15T00:00:00-03:00"0,
                    "dateInclusiongroupAccountId": "2017-09-15T11:44:42-03:00"0,
                    "companyIdDebitAccountaccountId": 60,
                    "debitAccount": "1.1.1.1.892"itemAmountRAS": 0,
                    "debitDescriptionapportionmentDebit": "COLIG. 6 FILIAL 12"[],
                    "companyIdCreditAccountapportionmentCredit": 6[],
                    "creditAccountvaluesCurrencies": "1.1.1.1.002"[],
                    "creditDescriptionapportionmentValuesCurrencies": "Caixa Filial Rio de Janeiro", []
                }
            ]
        "companyIdAgainstEntry": 0},
        {
            "valuereversal": 111.00false,
            "companyId": 6,
            "value2entryId": 200.0010,
            "batchCode": 0,
            "date2description": "2011-09-15T00:00:00-03:00BLOCO K",
            "accountEntry": [
       "integrateApplication": "C",         {
                    "originNewModentryNumberId": 19,
                    "generationTypebranchId": "O"12,
                    "userbranchName": "mestreESCOLA EXEMPLO 1",
                    "complementaryFields": {
     "date": "2017-04-11T00:00:00-03:00",
                    "codlotedateInclusion": 0"2018-04-11T16:01:07-03:00",
                        "lctrefcompanyIdDebitAccount": 86,
                        "idpartidadebitAccount": 8"1.1.1.1.017",
                    "debitDescription": "BLOCO K 200 D"idinteiro": 0
,
                    "companyIdCreditAccount": }6,
                    "batchCodeOrigincreditAccount": 0"2.1.1.1.015",
                    "userModifiedcreditDescription": "mestre200,00 C",
                    "operationIdcompanyIdAgainstEntry": 0,
                    "reversalAccountIdvalue": 0200.00,
                    "groupAccountIdvalue2": 0400.00,
                    "accountIddate2": 0"2017-04-11T00:00:00-03:00",
                    "itemAmountRAShistoricCode": 0"011",
                    "apportionmentDebitintegrateApplication": []"C",
                    "apportionmentCreditgenerationType": []"O",
                    "valuesCurrenciesuser": []"mestre",
                    "apportionmentValuesCurrenciescomplementaryFields": []{
                }
            ]"codlote": 0,
        },
        {
            "operationIdlctref": 09,
            "reversal": false,
            "companyIdidpartida": 69,
            "entryId": 10,
            "batchCodeidinteiro": 0,
                  "description": "BLOCO K"},
                    "accountEntrybatchCodeOrigin": [
0,
                    { "userModified": "mestre",
                    "companyIdoperationId": 60,
                    "batchCodereversalAccountId": 0,
                    "entryIdgroupAccountId": 100,
                    "entryNumberIdaccountId": 90,
                    "branchIditemAmountRAS": 120,
                    "branchNameapportionmentDebit": "ESCOLA EXEMPLO 1"[],
                    "dateapportionmentCredit": "2017-04-11T00:00:00-03:00"[],
                    "dateInclusionvaluesCurrencies": "2018-04-11T16:01:07-03:00"[],
                    "companyIdDebitAccountapportionmentValuesCurrencies": 6,
[]
                }
           "debitAccount": "1.1.1.1.017" ]
        },
        {
            "debitDescriptionreversal": false,
  "BLOCO K 200 D",
       "companyId": 6,
            "companyIdCreditAccountentryId": 611,
            "batchCode": 0,
            "creditAccountdescription": "2.1.1.1.015BLOCO K",
            "accountEntry": [
              "creditDescription": "200,00 C", {
                    "companyIdAgainstEntryentryNumberId": 010,
                    "valuebranchId": 200.0012,
                    "value2branchName": 400.00"ESCOLA EXEMPLO 1",
                    "date2date": "2017-04-11T00:00:00-03:00",
                    "historicCodedateInclusion": "0112018-04-11T17:06:56-03:00",
                    "integrateApplicationcompanyIdDebitAccount": "C"6,
                    "originNewModdebitAccount": "2.1.1.1.016",
                    "generationTypedebitDescription": "O585,76 D",
                    "usercompanyIdCreditAccount": "mestre"6,
                    "complementaryFieldscreditAccount": {"1.1.1.1.018",
                        "codlotecreditDescription": 0 "585,76 C",
                        "lctrefcompanyIdAgainstEntry": 90,
                        "idpartidavalue": 9585.76,
                        "idinteirovalue2": 01171.52,
                    } "date2": "2017-04-11T00:00:00-03:00",
                    "batchCodeOriginintegrateApplication": 0"C",
                    "userModifiedgenerationType": "mestreO",
                    "operationIduser": 0"mestre",
                    "reversalAccountIdcomplementaryFields": 0,
{
                        "groupAccountIdcodlote": 0,
                        "accountIdlctref": 010,
                        "itemAmountRASidpartida": 010,
                        "apportionmentDebitidinteiro": [],0
                    "apportionmentCredit": []},
                    "valuesCurrenciesbatchCodeOrigin": []0,
                    "apportionmentValuesCurrenciesuserModified": []
"mestre",
                     }
"operationId": 0,
             ]
       "reversalAccountId": }0,
        {
            "operationIdgroupAccountId": 0,
            "reversal": false,
            "companyIdaccountId": 60,
            "entryId": 11,
            "batchCodeitemAmountRAS": 0,
            "description": "BLOCO K",
       "apportionmentDebit": [],
    "accountEntry": [
                {"apportionmentCredit": [],
                    "companyIdvaluesCurrencies": 6[],
                    "batchCodeapportionmentValuesCurrencies": 0,[]
                },
     "entryId": 11,           {
                    "entryNumberId": 1011,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2017-04-11T00:00:00-03:00",
                    "dateInclusion": "2018-04-11T1711T18:0610:5639-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "2.1.1.1.016017",
                    "debitDescription": "5851122,7612 D",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "1.1.1.1.018019",
                    "creditDescription": "5851122,7612 C",
                    "companyIdAgainstEntry": 0,
                    "value": 5851122.7612,
                    "value2": 11712244.5224,
                    "date2": "2017-04-11T00:00:00-03:00",
                    "integrateApplication": "C",
                    "originNewMod": 1,
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 1011,
                        "idpartida": 1011,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrenciesitemAmountRAS": []0,
                    "apportionmentValuesCurrenciesapportionmentDebit": [],
                },
    "apportionmentCredit": [],
           {
         "valuesCurrencies": [],
          "companyId": 6,
         "apportionmentValuesCurrencies": []
          "batchCode": 0,
     },
               "entryId": 11, {
                    "entryNumberId": 1112,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2017-04-11T00:00:00-03:00",
                    "dateInclusion": "2018-04-11T18:1026:3903-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "21.1.1.1.017020",
                    "debitDescription": "11226,1200 D",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "12.1.1.1.019018",
                    "creditDescription": "11226,1200 C",
                    "companyIdAgainstEntry": 0,
                    "value": 11226.1200,
                    "value2": 224412.2400,
                    "date2": "2017-04-11T00:00:00-03:00",
                    "integrateApplicationhistoricCode": "C011",
                    "originNewModintegrateApplication": 1"C",
                    "generationType": "O",
                    "user": "mestre",
                    "complementaryFields": {
                        "codlote": 0,
                        "lctref": 1112,
                        "idpartida": 1112,
                        "idinteiro": 0
                    },
                    "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId": 0,
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": []
                },
                {
                    "companyId": 6,
                    "batchCode": 0,
                    "entryId": 11,  {
                    "entryNumberId": 1213,
                    "branchId": 12,
                    "branchName": "ESCOLA EXEMPLO 1",
                    "date": "2017-04-11T00:00:00-03:00",
                    "dateInclusion": "2018-04-11T18:2636:0357-03:00",
                    "companyIdDebitAccount": 6,
                    "debitAccount": "12.1.1.1.020019",
                    "debitDescription": "6256,00 D",
                    "companyIdCreditAccount": 6,
                    "creditAccount": "21.1.1.1.018021",
                    "creditDescription": "6256,00 C",
                    "companyIdAgainstEntry": 0,
                    "value": 6256.00,
                    "value2": 12512.00,
                    "date2": "2017-04-11T00:00:00-03:00",
                    "historicCodeintegrateApplication": "011C",
                    "integrateApplicationgenerationType": "CO",
                    "originNewModuser": 1"mestre",
                    "generationTypecomplementaryFields": {
                        "Ocodlote": 0,
                        "userlctref": "mestre"13,
                        "complementaryFieldsidpartida": {13,
                        "codloteidinteiro": 0,

                    },
                    "lctrefbatchCodeOrigin": 120,
                    "userModified": "mestre",
     "idpartida               "operationId": 120,
                    "reversalAccountId": 0,
                    "idinteirogroupAccountId": 0,
                    }"accountId": 0,
                    "batchCodeOriginitemAmountRAS": 0,
                    "userModifiedapportionmentDebit": "mestre"[],
                    "operationIdapportionmentCredit": 0[],
                    "reversalAccountIdvaluesCurrencies": 0[],
                    "groupAccountIdapportionmentValuesCurrencies": 0,[]
                }
    "accountId": 0,        ]
                    "itemAmountRAS": 0,
                    "apportionmentDebit": [],
                    "apportionmentCredit": [],
                    "valuesCurrencies": [],
                    "apportionmentValuesCurrencies": [] }
    ]
}

2.1.5 - Fields (Retorno de campos específicos no resultado)

...

Informações

title	Parâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações

icon	false
title	Fields

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?fields={campos}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: entryId

Campo 2: batchCode

Campo 3: description

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?fields=entryId,batchCode,description

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
                },{
                {
 "entryId": 9,
                   "companyId"batchCode": 60,
            "description": "GAS"
       "batchCode": 0},
        {
            "entryId": 1110,
                    "entryNumberIdbatchCode": 130,
            "description": "BLOCO K"
      "branchId": 12  },
        {
            "branchNameentryId": "ESCOLA EXEMPLO 1"11,
                    "datebatchCode": "2017-04-11T00:00:00-03:00"0,
            "description": "BLOCO K"
      "dateInclusion": "2018-04-11T18:36:57-03:00"  },
        {
            "companyIdDebitAccountentryId": 612,
                    "debitAccountbatchCode": "2.1.1.1.019"0,
            "description": "EQUIVALENCIA - AUTOMAÇÃO put"
      "debitDescription": "256,00 D" },
        {
            "companyIdCreditAccountentryId": 614,
            "batchCode": 50,
            "creditAccountdescription": "1.1.1.1.021",Contabilização aquisição do Patrimônio 01.01.001__1"
        },
        {
    "creditDescription": "256,00 C",
      "entryId": 20,
             "companyIdAgainstEntrybatchCode": 0,
            "description": "GAS 2"
       "value": 256.00 },
        {
            "value2entryId": 512.0022,
            "batchCode": 0,
            "date2description": "2017-04-11T00:00:00-03:00",GAS 2"
        },
        {
    "integrateApplication": "C",
       "entryId": 23,
            "originNewModbatchCode": 10,
            "description": "GAS"
       "generationType": "O" },
        {
            "userentryId": "mestre"24,
            "batchCode": 0,
            "complementaryFieldsdescription": {
"GAS"
        },
        {
            "codloteentryId": 026,
            "batchCode": 0,
            "lctrefdescription": 13,
"GAS"
        },
        {
            "idpartidaentryId": 1329,
                        "idinteiro"batchCode": 0,
            "description": "EQUIVALENCIA - AUTOMAÇÃO"
     },
   }
                 "batchCodeOrigin": 0,
                    "userModified": "mestre",
                    "operationId": 0,
                    "reversalAccountId": 0,
                    "groupAccountId": 0,
                    "accountId]
}

2.1.6 - GetOne (Recuperar Lançamento e Partida pela chave composta)

...

Informações

title	Parâmetros

Nos parâmetros do GetOne é necessário passar uma chave composta ("id"), por isso informamos "companyId" é o código da coligada de Lançamento que queremos selecionar, o "entryId" é o Id de Lançamento, o "batchCode" é o código Lote, sendo eles separados pelo caractere "|" pipe.

Informações

icon	false
title	GetOne

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}/{entryId}|{batchCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

companyId: 6

entryId: 9

batchCode: 0

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6/9|0

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "reversal": false,
    "companyId": 6,
    "entryId": 9,
    "batchCode": 0,
                    "itemAmountRAS"description": 0"GAS",
                    "apportionmentDebitaccountEntry": [],
        {
            "apportionmentCreditentryNumberId": []8,
                    "valuesCurrenciesbranchId": []12,
                    "apportionmentValuesCurrenciesbranchName": []
"ESCOLA EXEMPLO 1",
            "date":  }
"2011-09-15T00:00:00-03:00",
             ]"dateInclusion": "2017-09-15T11:44:42-03:00",
        }
    ]
}

2.1.5 - Fields (Retorno de campos específicos no resultado)

Informações

title	Parâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações

icon	false
title	Fields

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}?fields={campos}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: entryId

Campo 2: batchCode

Campo 3: description

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6?fields=entryId,batchCode,description

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
"companyIdDebitAccount": 6,
            "debitAccount": "1.1.1.1.892",
            "debitDescription": "COLIG. 6 FILIAL 12",
            "companyIdCreditAccount": 6,
            {"creditAccount": "1.1.1.1.002",
            "entryIdcreditDescription": 9 "Caixa Filial Rio de Janeiro",
            "batchCodecompanyIdAgainstEntry": 0,
            "descriptionvalue": 111.00,
      "GAS"      "value2": 200.00,
        },
        {"date2": "2011-09-15T00:00:00-03:00",
            "entryIdintegrateApplication": 10"C",
            "batchCodegenerationType": 0"O",
            "descriptionuser": "BLOCO Kmestre",
         },
   "complementaryFields": {
    {
            "entryIdcodlote": 110,
                "batchCodelctref": 08,
                "descriptionidpartida": "BLOCO K"
8,
         },
       "idinteiro": {0
            "entryId": 12},
            "batchCodebatchCodeOrigin": 0,
            "descriptionuserModified": "EQUIVALENCIA - AUTOMAÇÃOmestre",
        },
        {"operationId": 0,
            "entryIdreversalAccountId": 130,
            "batchCodegroupAccountId": 0,
            "descriptionaccountId": "EQUIVALENCIA - AUTOMACAO"0,
        },
        {"itemAmountRAS": 0,
            "entryIdapportionmentDebit": 14[],
            "batchCodeapportionmentCredit": 50[],
            "descriptionvaluesCurrencies": "Contabilização aquisição do Patrimônio 01.01.001__1" [],
            "apportionmentValuesCurrencies": []
        }
    ]
}

2.2 - POST

...

2.2.1

...

-

...

Post (

...

Inserir um Lançamento e Partida

...

)

...

Parâmetros

Informações

title

Nos parâmetros do GetOne é necessário passar uma chave composta ("id"), por isso informamos "companyId" é o código da coligada de Lançamento que queremos selecionar, o "entryId" é o Id de Lançamento, o "batchCode" é o código Lote, sendo eles separados pelo caractere "|" pipe.

Informações

icon	false
title	GetOnePost

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}/{entryId}|{batchCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

companyId: 6

entryId: 9

batchCode: 0

8051

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6/9|0

Informações

icon	false
title	Exemplo de ResultadoEntrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationId": 0,
    "reversal": false,
    "companyId": 6,
    "entryId": 912,
    "batchCode": 0,
    "description": "GAS",
    "accountEntry": [
        {
            "companyIduserId": 6"mestre",
    "description": "EQUIVALENCIA - AUTOMAÇÃO put",
    "batchCodeaccountEntry": 0,[
            "entryId": 9,{
            "entryNumberId": 814,
            "branchId": 12,
            "branchName": "ESCOLA EXEMPLO 1",
            "date": "2011-0905-15T0007T00:00:00-03:00",
            "dateInclusion": "20172019-09-15T1112T11:4431:4248-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "1.1.1.1.892001",
            "debitDescription": "COLIG. 6 FILIAL 12Caixa Geral",
            "companyIdCreditAccount": 6,
            "creditAccount": "14.1.1.1.002001",
            "creditDescription": "CaixaVendas Filialde RioSistemas de JaneiroContabilidade",
            "companyIdAgainstEntry": 0,
            "value": 111500000.00,
            "value2": 2001000000.00,
            "date2": "2011-0905-15T0007T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1,
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 814,
                "idpartida": 814,
                "idinteiro": 0
            },
            "batchCodeOrigin": 0,
            "userModified": "mestre",
            "operationId": 0,
            "reversalAccountId": 0,
            "groupAccountId": 0,
            "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [],
            "apportionmentCredit": [],
            "valuesCurrencies": []"valuesCurrencies": [],
            "apportionmentValuesCurrencies": []
        },
        {
            "entryNumberId": 15,
            "branchId": 12,
            "apportionmentValuesCurrenciesbranchName": [] "ESCOLA EXEMPLO 1",
        }
     ]
}

2.2 - POST

2.2.1 - Post (Inserir um Lançamento e Partida)

Informações

icon	false
title	Post

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
"date": "2011-05-07T00:00:00-03:00",
            "operationIddateInclusion": 0"2019-09-12T11:31:48-03:00",
       "reversal": false,
    "companyIdcompanyIdDebitAccount": 6,
    "entryId": 12,
    "batchCode": 0,
    "descriptiondebitAccount": "EQUIVALENCIA - AUTOMAÇÃO3.1.1.3.001",
    "accountEntry": [
        {"debitDescription": "DESPESAS FINANCEIRAS",
            "companyIdcompanyIdCreditAccount": 6,
            "batchCodecreditAccount": 0"1.1.1.1.001",
            "entryIdcreditDescription": "Caixa 12Geral",
            "entryNumberIdcompanyIdAgainstEntry": 140,
            "branchIdvalue": 12250000.00,
            "branchNamevalue2": "ESCOLA EXEMPLO 1"500000.00,
            "datedate2": "2011-05-07T00:00:00-03:00",
            "dateInclusionintegrateApplication": "2019-09-12T11:31:48-03:00C",
            "companyIdDebitAccountgenerationType": 6"O",
            "debitAccountuser": "1.1.1.1.001mestre",
            "debitDescriptioncomplementaryFields": {
         "Caixa Geral",
       "codlote": 0,
                "companyIdCreditAccountlctref": 615,
                "creditAccountidpartida": "4.1.1.1.001"15,
                "creditDescriptionidinteiro": "Vendas de Sistemas de Contabilidade"0
            },
            "companyIdAgainstEntrybatchCodeOrigin": 0,
            "valueuserModified": 500000.00"mestre",
            "value2operationId": 1000000.000,
            "date2reversalAccountId": "2011-05-07T00:00:00-03:00"0,
            "integrateApplicationgroupAccountId": "C"0,
            "originNewModaccountId": 10,
            "generationTypeitemAmountRAS": "O"0,
            "userapportionmentDebit": "mestre"[],
            "complementaryFieldsapportionmentCredit": {[],
                "codlotevaluesCurrencies": 0[],
            "apportionmentValuesCurrencies": []
   "lctref": 14,
    }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
        "idinteiroreversal": 0false,
    "companyId": 6,
       },
       "entryId": 30,
     "batchCodeOriginbatchCode": 0,
    "description": "EQUIVALENCIA - AUTOMAÇÃO",
     "operationIdaccountEntry": 0,[
            "reversalAccountId": 0,{
            "groupAccountIdentryNumberId": 037,
            "accountIdbranchId": 012,
            "itemAmountRASbranchName": 0 "ESCOLA EXEMPLO 1",
            "apportionmentDebitdate": []"2011-05-07T00:00:00-03:00",
            "apportionmentCreditdateInclusion": []"2019-09-12T11:31:48-03:00",
            "valuesCurrenciescompanyIdDebitAccount": []6,
            "apportionmentValuesCurrenciesdebitAccount": []"1.1.1.1.001",
        },
    "debitDescription":    {"Caixa Geral",
            "companyIdcompanyIdCreditAccount": 6,
            "batchCodecreditAccount": 0"4.1.1.1.001",
            "entryIdcreditDescription": 12"Vendas de Sistemas de Contabilidade",
            "entryNumberIdcompanyIdAgainstEntry": 150,
            "branchIdvalue": 12500000.00,
            "branchNamevalue2": "ESCOLA EXEMPLO 1"1000000.00,
            "datedate2": "2011-05-07T00:00:00-03:00",
            "dateInclusionintegrateApplication": "2019-09-12T11:31:48-03:00C",
            "companyIdDebitAccountgenerationType": 6"O",
            "debitAccountuser": "3.1.1.3.001mestre",
            "debitDescriptioncomplementaryFields": {
   "DESPESAS FINANCEIRAS",
            "companyIdCreditAccountcodlote": 60,
                "creditAccountlctref": "1.1.1.1.001"35,
                "creditDescriptionidpartida": "Caixa Geral"37,
                "companyIdAgainstEntryidinteiro": 0,
            "value": 250000.00},
            "value2batchCodeOrigin": 500000.000,
            "date2operationId": "2011-05-07T00:00:00-03:00"0,
            "integrateApplicationreversalAccountId": "C"0,
            "originNewModgroupAccountId": 10,
            "generationTypeaccountId": "O"0,
            "useritemAmountRAS": "mestre"0,
            "complementaryFieldsapportionmentDebit": {[],
                "codloteapportionmentCredit": 0,
   [],
             "lctrefvaluesCurrencies": 15[],
            "apportionmentValuesCurrencies": []
   "idinteiro": 0
    },
        },{
            "batchCodeOriginentryNumberId": 038,
            "operationIdbranchId": 012,
            "reversalAccountIdbranchName": 0"ESCOLA EXEMPLO 1",
            "groupAccountIddate": 0"2011-05-07T00:00:00-03:00",
            "accountIddateInclusion": 0"2019-09-12T11:31:48-03:00",
            "itemAmountRAScompanyIdDebitAccount": 06,
            "apportionmentDebitdebitAccount": []"3.1.1.3.001",
            "apportionmentCreditdebitDescription": [] "DESPESAS FINANCEIRAS",
            "valuesCurrenciescompanyIdCreditAccount": []6,
            "apportionmentValuesCurrenciescreditAccount": []"1.1.1.1.001",
        }
     ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
"creditDescription": "Caixa Geral",
            "operationIdcompanyIdAgainstEntry": 0,
            "reversalvalue": false250000.00,
      "companyId": 6,
      "entryIdvalue2": 29500000.00,
       "batchCode": 0,
    "descriptiondate2": "EQUIVALENCIA - AUTOMAÇÃO2011-05-07T00:00:00-03:00",
    "accountEntry": [
        {"integrateApplication": "C",
            "companyIdgenerationType": 6"O",
            "batchCodeuser": 0"mestre",
            "entryIdcomplementaryFields": 29,
{
                "entryNumberIdcodlote": 330,
                "branchIdlctref": 1236,
                "branchNameidpartida": "ESCOLA EXEMPLO 1",
38,
                "dateidinteiro": "2011-05-07T00:00:00-03:00"0
            },
            "dateInclusionbatchCodeOrigin": "2019-09-12T11:31:48-03:00"0,
            "companyIdDebitAccountoperationId": 60,
            "debitAccountreversalAccountId": "1.1.1.1.001"0,
            "debitDescriptiongroupAccountId": "Caixa Geral"0,
            "companyIdCreditAccountaccountId": 60,
            "creditAccountitemAmountRAS": "4.1.1.1.001"0,
            "creditDescriptionapportionmentDebit": "Vendas de Sistemas de Contabilidade" [],
            "apportionmentCredit": [],
            "companyIdAgainstEntryvaluesCurrencies": 0[],
            "valueapportionmentValuesCurrencies": 500000.00,[]
        }
    "value2": 1000000.00,
            "date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1]
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": "FE006",
    "message": "Chave duplicada\r\n\r\nPossíveis causas:\r\n  - inclusão de registro cujo valor da chave primária já existe\r\n  - inclusão de registro cujo valor do índice único já existe",
    "detailedMessage": null,
    "helpUrl": null,
    "details": [
       "generationType": "O", {
            "usercode": "mestreException",
            "complementaryFieldsmessage": {
"Violation of PRIMARY KEY constraint 'PKCLCOMPL'. Cannot insert duplicate key in object 'dbo.CLCOMPL'. The duplicate key value "codlote": 0,
     is (6, 8).\r\nThe statement has been terminated.",
            "lctrefdetailedMessage": 31null,
                "idpartidahelpUrl": 33null,
                "idinteirodetails": 0[
            },
    {
        "batchCodeOrigin": 0,
            "operationIdcode": 0"Exception",
            "reversalAccountId": 0,
            "groupAccountIdmessage": 0,
"INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE],  "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [],
     [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', null, null, 0)",
       "apportionmentCredit": [],
            "valuesCurrenciesdetailedMessage": []null,
            "apportionmentValuesCurrencies": []
       "helpUrl": }null,
        {
            "companyIddetails": 6,null
              "batchCode": 0,
  }
            ]
  "entryId": 29,
     },
       "entryNumberId": 34, {
            "branchIdcode": 12"Exception",
            "branchNamemessage": "ESCOLA EXEMPLO 1",
            "date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE], [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', null, null, 0)",
            "companyIdDebitAccountdetailedMessage": 6null,
            "debitAccounthelpUrl": "3.1.1.3.001"null,
            "debitDescriptiondetails": "DESPESAS FINANCEIRAS",null
            "companyIdCreditAccount": 6,
            "creditAccount": "1.1.1.1.001",
            "creditDescription": "Caixa Geral",
            "companyIdAgainstEntry": 0,
            "value": 250000.00,
            "value2": 500000.00,
            }
    ]
}

2.3 - PATCH

...

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)

...

Informações

icon	false
title	Patch

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}/{entryId}|{batchCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

CompanyId: 6

entryId: 12

batchCode: 0

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6/12|0

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationId": 0,
    "reversal": false,
    "companyId": 6,
    "entryId": 12,
    "batchCode": 0,
    "description": "EQUIVALENCIA - AUTOMAÇÃO"date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
    "accountEntry": [
       "originNewMod": 1, {
            "generationTypecompanyId": "O"6,
            "userbatchCode": "mestre"0,
            "complementaryFieldsentryId": {12,
                "codloteentryNumberId": 014,
                "lctrefbranchId": 3212,
            "branchName": "ESCOLA EXEMPLO 1 "idpartida2": 34,
                "idinteirodebitDescription": 0
"Caixa Geral 2 ",
         },
   "creditDescription": "Vendas de Sistemas de Contabilidade 2"
   "batchCodeOrigin": 0,
    }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationIdreversal": 0,
       false,
     "reversalAccountIdcompanyId": 06,
        "entryId": 12,
    "groupAccountIdbatchCode": 0,
    "description": "EQUIVALENCIA -  AUTOMAÇÃO",
    "accountIdaccountEntry": 0,[
            "itemAmountRAS": 0,{
            "apportionmentDebitentryNumberId": []14,
            "apportionmentCreditbranchId": []12,
            "valuesCurrenciesbranchName": [] "ESCOLA EXEMPLO 1",
            "apportionmentValuesCurrenciesdate": []"2011-05-07T00:00:00-03:00",
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code"dateInclusion": "FE006",
    "message": "Chave duplicada\r\n\r\nPossíveis causas:\r\n  - inclusão de registro cujo valor da chave primária já existe\r\n  - inclusão de registro cujo valor do índice único já existe",
    "detailedMessage": null,
    "helpUrl": null2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "1.1.1.1.001",
            "debitDescription": "Caixa Geral",
    "details": [
        {"companyIdCreditAccount": 6,
            "codecreditAccount": "Exception4.1.1.1.001",
            "messagecreditDescription": "Vendas de Sistemas de Contabilidade"Violation,
    of PRIMARY KEY constraint 'PKCLCOMPL'. Cannot insert duplicate key in object 'dbo.CLCOMPL'. The duplicate key value is (6, 8).\r\nThe statement has been terminated.""companyIdAgainstEntry": 0,
            "value": 500000.00,
            "detailedMessagevalue2": null1000000.00,
            "helpUrldate2": null"2011-05-07T00:00:00-03:00",
            "detailsintegrateApplication": ["C",
                {
 "generationType": "O",
                   "code"user": "Exceptionmestre",
            "complementaryFields": {
       "message": "INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE], [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', null, null, 0)",
     "codlote": 0,
                "lctref": 14,
                "idpartida": 14,
                "detailedMessageidinteiro": null,
0
            },
            "helpUrlbatchCodeOrigin": null0,
            "userModified": "mestre",
            "detailsoperationId": null0,
            "reversalAccountId": 0,
     }
       "groupAccountId": 0,
    ]
        }"accountId": 0,
            { "itemAmountRAS": 0,
            "codeapportionmentDebit": "Exception"[],
            "messageapportionmentCredit": "INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE], [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', null, null, 0)", [],
            "valuesCurrencies": [],
            "apportionmentValuesCurrencies": []
        },
        {
            "detailedMessageentryNumberId": null15,
            "helpUrlbranchId": null12,
            "detailsbranchName": null "ESCOLA EXEMPLO 1",
        }
    ]
}

2.3 - PATCH

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)

Informações

icon	false
title	Patch

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}/{entryId}|{batchCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

CompanyId: 6

entryId: 12

batchCode: 0

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6/12|0

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationId": 0,
    "reversal": false,
    "companyId": 6,
    "entryId": 12,
    "batchCode": 0,
    "description": "EQUIVALENCIA - AUTOMAÇÃO",
    "accountEntry": ["date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "3.1.1.3.001",
            "debitDescription": "DESPESAS FINANCEIRAS",
            "companyIdCreditAccount": 6,
            "creditAccount": "1.1.1.1.001",
            "creditDescription": "Caixa Geral",
            "companyIdAgainstEntry": 0,
            "value": 250000.00,
            "value2": 500000.00,
        {    "date2": "2011-05-07T00:00:00-03:00",
            "companyIdintegrateApplication": 6"C",
            "batchCodegenerationType": 0"O",
            "entryIduser": 12"mestre",
            "entryNumberIdcomplementaryFields": 14,{
                "branchIdcodlote": 120,
                "branchNamelctref": "ESCOLA EXEMPLO 1 2",
15,
                "debitDescriptionidpartida": "Caixa Geral 2 ",
 15,
                "idinteiro": 0
      "creditDescription": "Vendas de Sistemas de Contabilidade 2"},
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
	"id": "1|TesteAPI",
    "company": 1,
"batchCodeOrigin": 0,
            "codeuserModified": "TesteAPImestre",
    "description": "Teste edição conta caixa",
    "instantBalanceoperationId": 0.0000,
       "databaseBalance": 0.0000,
    "cashAccountDatabasereversalAccountId": "2023-10-31T00:00:00-03:00"0,
    "lastNumberCheckBank": "124758",
    "proprietaryCompany": 1,
    "unpaidBalancegroupAccountId": 0.0000,
       "currencyCode": "R$",
    "bankAccountCompanyaccountId": 10,
      "userLowerLimit": 1,
      "lowerLimititemAmountRAS": 15000.0,
            "allowOpenningapportionmentDebit": 1[],
            "lastCashNumberapportionmentCredit": "00005"[],
     "active": 1,
       "cpmfAutomaticvaluesCurrencies": 0[],
       "branchCode": 1,
    "batchCodeapportionmentValuesCurrencies": 0,[]
      "refundBatchCode": 0,  }
    "cutoffDateBalance": 0.0000]
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE016",
    "Message": "O Corpo da mensagem contêm valores inválidos.",
    "DetailMessage": "",
    "HelpUrl": "http://tdn.totvs.com/x/e0F0GQ",
    "Details": null
}

...

Informações

icon	false
title	Put

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/AccountingEntries/{companyId}/{entryId}|{batchCode}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

companyId: 6

entryId: 12

batchCode: 0

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntries/6/12|0

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationId": 0,
    "reversal": false,
    "companyId": 6,
    "entryId": 12,
    "batchCode": 0,
    "description": "EQUIVALENCIA - AUTOMAÇÃO put",
    "accountEntry": [
        {
       "reversal": false,
    "companyId": 6,
    "entryId": 12,
    "batchCode": 0,
    "batchCodeuserId": 0"mestre",
    "description": "EQUIVALENCIA - AUTOMAÇÃO put",
    "entryIdaccountEntry": 12, [
        {
            "entryNumberId": 14,
            "branchId": 12,
            "branchName": "ESCOLA EXEMPLO 1",
            "date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "1.1.1.1.001",
            "debitDescription": "Caixa Geral",
            "companyIdCreditAccount": 6,
            "creditAccount": "4.1.1.1.001",
            "creditDescription": "Vendas de Sistemas de Contabilidade",
            "companyIdAgainstEntry": 0,
            "value": 500000.00,
            "value2": 1000000.00,
            "date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1,
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 14,
                "idpartida": 14,
                "idinteiro": 0
            },
            "batchCodeOrigin": 0,
            "operationIduserModified": 0"mestre",
            "reversalAccountIdoperationId": 0,
            "groupAccountIdreversalAccountId": 0,
            "accountIdgroupAccountId": 0,
            "itemAmountRASaccountId": 0,
            "apportionmentDebititemAmountRAS": []0,
            "apportionmentCreditapportionmentDebit": [],
            "valuesCurrenciesapportionmentCredit": [],
            "apportionmentValuesCurrenciesvaluesCurrencies": []
        },
        {
            "companyIdapportionmentValuesCurrencies": 6,[]
            "batchCode": 0},
            "entryId": 12,{
            "entryNumberId": 15,
            "branchId": 12,
            "branchName": "ESCOLA EXEMPLO 1",
            "date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "3.1.1.3.001",
            "debitDescription": "DESPESAS FINANCEIRAS",
            "companyIdCreditAccount": 6,
            "creditAccount": "1.1.1.1.001",
            "creditDescription": "Caixa Geral",
            "companyIdAgainstEntry": 0,
            "value": 250000.00,
            "value2": 500000.00,
            "date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1,
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 15,
                "idpartida": 15,
                "idinteiro": 0
 0
            },
            "batchCodeOrigin": }0,
            "batchCodeOriginuserModified": 0"mestre",
            "operationId": 0,
            "reversalAccountId": 0,
            "groupAccountId": 0,
            "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [],
            "apportionmentCredit": [],
            "valuesCurrencies": [],
            "apportionmentValuesCurrencies": []
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "operationId": 0,
    "reversal": false,
    "companyId": 6,
    "entryId": 12,
    "batchCode": 0,
    "description": "EQUIVALENCIA - AUTOMAÇÃO put",
    "accountEntry": [
        {
            "companyId": 6,
            "batchCode": 0,
            "entryId": 12,
            "entryNumberId": 14,
            "branchId": 12,
            "branchName": "ESCOLA EXEMPLO 1",
            "date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "1.1.1.1.001",
            "debitDescription": "Caixa Geral",
            "companyIdCreditAccount": 6,
            "creditAccount": "4.1.1.1.001",
            "creditDescription": "Vendas de Sistemas de Contabilidade",
            "companyIdAgainstEntry": 0,
            "value": 500000.00,
            "value2": 1000000.00,
            "date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1,
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 14,
                "idpartida": 14,
                "idinteiro": 0
            },
            "batchCodeOrigin": 0,
            "userModified": "mestre",
            "operationId": 0,
            "reversalAccountId": 0,
            "groupAccountId": 0,
            "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [],
            "apportionmentCredit": [],
            "valuesCurrencies": [],
            "apportionmentValuesCurrencies": []
        },
        {
            "companyId": 6,
            "batchCode": 0,
            "entryId": 12,
            "entryNumberId": 15,
            "branchId": 12,
            "branchName": "ESCOLA EXEMPLO 1",
            "date": "2011-05-07T00:00:00-03:00",
            "dateInclusion": "2019-09-12T11:31:48-03:00",
            "companyIdDebitAccount": 6,
            "debitAccount": "3.1.1.3.001",
            "debitDescription": "DESPESAS FINANCEIRAS",
            "companyIdCreditAccount": 6,
            "creditAccount": "1.1.1.1.001",
            "creditDescription": "Caixa Geral",
            "companyIdAgainstEntry": 0,
            "value": 250000.00,
            "value2": 500000.00,
            "date2": "2011-05-07T00:00:00-03:00",
            "integrateApplication": "C",
            "originNewMod": 1,
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 15,
                "idpartida": 15,
                "idinteiro": 0
            },
            "batchCodeOrigin": 0,
            "userModified": "mestre",
            "operationId": 0,
            "reversalAccountId": 0,
            "groupAccountId": 0,
            "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [],
            "apportionmentCredit": [],
            "valuesCurrencies": [],
            "apportionmentValuesCurrencies": []
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultados Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": "FE013",
    "message": "Os campos que compõem a chave primária não podem ser diferentes dos informados na requisição.",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": "FE019",
    "message": "Erro durante a requisição de alteração do registro. A partida não foi incluída, pois a Conta Contábil 1.1.1.1.00 da Coligada 6 não foi encontrada no plano de Contas",
    "detailedMessage": null,
    "helpUrl": null,
    "details": null
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": "FE016",
    "message": "O campo \"companyId - Código da Coligada\" deve ser preenchido no Lançamento e na Partida.",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "code": "FE006",
    "message": "Chave duplicada\r\n\r\nPossíveis causas:\r\n  - inclusão de registro cujo valor da chave primária já existe\r\n  - inclusão de registro cujo valor do índice único já existe",
    "detailedMessage": null,
    "helpUrl": null,
    "details": [
        {
            "code": "Exception",
            "message": "Violation of PRIMARY KEY constraint 'PKCLCOMPL'. Cannot insert duplicate key in object 'dbo.CLCOMPL'. The duplicate key value is (6, 14).\r\nThe statement has been terminated.",
            "detailedMessage": null,
            "helpUrl": null,
            "details": [
                {
                    "code": "Exception",
                    "message": "INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE], [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 33, null, null, , null, null, null, 14, 'mestre', '26/03/2024 11:02:14', 'mestre', '26/03/2024 11:02:14', null, null, 0)",
                    "detailedMessage": null,
                    "helpUrl": null,
                    "details": null
                }
            ]
        },
        {
            "code": "Exception",
            "message": "INSERT INTO [CLCOMPL] ([CODCOLIGADA], [CODLOTE], [LCTREF], [DOCUMENTO], [DIGITADOR], [KWHORA], [DATA], [VALIDADE], [RESPONSABILIDADE], [IDPARTIDA], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON], [SPEDFCONT], [IDDMPL], [IDINTEIRO]) VALUES (6, 0, 33, null, null, , null, null, null, 14, 'mestre', '26/03/2024 11:02:14', 'mestre', '26/03/2024 11:02:14', null, null, 0)",
            "detailedMessage": null,
            "helpUrl": null,
            "details": null
        }
    ]
}

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

2.1.2 - Order (Retorna os dados ordenados)

2.1.3 - Filter (Resultado filtrado)

2.1.4 - Paginação

2.1.3 - Filter (Resultado filtrado)

2.1.4 - Paginação

2.1.5 - Fields (Retorno de campos específicos no resultado)

2.1.6 - GetOne (Recuperar Lançamento e Partida pela chave composta)

2.1.5 - Fields (Retorno de campos específicos no resultado)

2.2 - POST

2.2.1

-

Post (

Inserir um Lançamento e Partida

)

2.2 - POST

2.2.1 - Post (Inserir um Lançamento e Partida)

2.3 - PATCH

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)

2.3 - PATCH

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 16

Nova versão 17

Chave

2.1.2 - Order (Retorna os dados ordenados)

2.1.3 - Filter (Resultado filtrado)

2.1.4 - Paginação

2.1.3 - Filter (Resultado filtrado)

2.1.4 - Paginação

2.1.5 - Fields (Retorno de campos específicos no resultado)

2.1.6 - GetOne (Recuperar Lançamento e Partida pela chave composta)

2.1.5 - Fields (Retorno de campos específicos no resultado)

2.2 - POST

2.2.1

-

Post (

Inserir um Lançamento e Partida

)

2.2 - POST

2.2.1 - Post (Inserir um Lançamento e Partida)

2.3 - PATCH

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)

2.3 - PATCH

2.3.1 - Patch (Atualização parcial de um Lançamento e Partida) (INCOMPLETO)