Versões comparadas

Chave

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

...

      Métodos disponíveis na API de Lançamento Contábil Solicitação de Aprovação de Lotes:

Informações
iconfalse
Informações
iconfalse
Expandir
titlePost (Inserir um Lançamento e Partida)

POST:Cria um novo lançamento no sistema.  Solicita a Aprovação dos Lotes enviados

Informações
iconfalse
titlePost

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

CompanyId: 1

Url Utilizada: http://localhost:8051/api/ctb/v1/AccountingEntrieslotLancApproval/1requestApproval

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...

O JSON abaixo contém os dados para incluir uma nova partida na coligada 1 (um). Além dos dados comuns, estamos enviando informações de rateio gerencial, valores de multimoeda e campo complementar.

No caso de campo complementar observe que na requisição de envio os campos chave são suprimidos.

Bloco de código
languagejs
themeEmacs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "companyId": 1,
    "entryId": 0,
    "batchCode": 0,
    "userId": "mestre",
    "description": "Inclusão de Lançamento VIA API com rateio - POST",
    "accountEntry": [
        {
            "entryNumberId": 0,
            "branchId": 1,
            "departmentCode": "05",
            "costCenterCode": "02.2.2.5",
            "date": "2020-03-02T00:00:00-03:00",
            "dateInclusion": "2024-04-03T14:45:58-03:00",
            "companyIdDebitAccount": 1,
            "debitAccount": "1.1.1.1.004",
            "companyIdCreditAccount": 1,
            "creditAccount": "1.1.1.1.900",
            "companyIdAgainstEntry": 0,
            "value": 1000.00,
            "value2": 300.00,
            "date2": "2020-03-02T00:00:00-03:00",
            "complementaryFields": {
                "responsabilidade": "03"
            },
            "apportionmentDebit": [
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "1.01.01.4",
                    "apportionmentId": 1094,
                    "entryNumberId": 0,
                    "value": 800.00
                },
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "1.01.02.2",
                    "apportionmentId": 1095,
                    "entryNumberId": 0,
                    "value": 200.00
                }
            ],
            "apportionmentCredit": [
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "5.01",
                    "apportionmentId": 1096,
                    "entryNumberId": 0,
                    "value": 680.00
                },
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "5.02",
                    "apportionmentId": 0,
                    "entryNumberId": 12765,
                    "value": 320.00
                }
            ],
            "valuesCurrencies": [
                {
                    "companyId": 1,
                    "entryNumberId": 12765,
                    "currency": "$",
                    "value": 5000.0000
                },
                {
                    "companyId": 1,
                    "entryNumberId": 12765,
                    "currency": "€",
                    "value": 7000.0000
                }
            ]
        }
    ]
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...

Na resposta do resultado, são retornadas algumas informações adicionais. Destacamos especialmente o cálculo do rateio de multimoeda, realizado pelo sistema, bem como o valor percentual do rateio gerencial.

Bloco de código
languagejs
themeRDark
firstline1
titleResultado (JSON)
linenumberstrue
{
    "reversal": false,
    "companyId": 1,
    "entryId": 3001,
    "batchCode": 0,
    "description": "Inclusão de Lançamento VIA API com rateio - POST",
    "accountEntry": [
        {
            "entryNumberId": 12768,
            "branchId": 1,
            "branchName": "TOTVS - Filial Belo Horizonte",
            "departmentCode": "05",
            "departmentName": "DCO - Depto Contabilidade",
            "costCenterCode": "02.2.2.5",
            "date": "2020-03-02T00:00:00-03:00",
            "dateInclusion": "2024-04-03T14:45:58-03:00",
            "companyIdDebitAccount": 1,
            "debitAccount": "1.1.1.1.004",
            "debitDescription": "Caixa Filial Belo Horizonte",
            "companyIdCreditAccount": 1,
            "creditAccount": "1.1.1.1.900",
            "creditDescription": "ACOMPANHAMENTO ORÇAMENTÁRIO",
            "companyIdAgainstEntry": 0,
            "value": 1000.00,
            "value2": 300.00,
            "date2": "2020-03-02T00:00:00-03:00",
            "integrateApplication": "C",
            "generationType": "O",
            "user": "mestre",
            "complementaryFields": {
                "codlote": 0,
                "lctref": 13236,
                "responsabilidade": "03",
                "idpartida": 12768
            },
            "batchCodeOrigin": 0,
            "operationId": 0,
            "reversalAccountId": 0,
            "groupAccountId": 0,
            "accountId": 0,
            "itemAmountRAS": 0,
            "apportionmentDebit": [
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "1.01.01.4",
                    "apportionmentId": 1106,
                    "entryNumberId": 12768,
                    "value": 800.00,
                    "percentual": "80,000000000000000000"
                },
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "1.01.02.2",
                    "apportionmentId": 1107,
                    "entryNumberId": 12768,
                    "value": 200.00,
                    "percentual": "20,000000000000000000"
                }
            ],
            "apportionmentCredit": [
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "5.01",
                    "apportionmentId": 1108,
                    "entryNumberId": 12768,
                    "value": 680.00,
                    "percentual": "68,000000000000000000"
                },
                {
                    "companyId": 1,
                    "date": "2020-03-02T00:00:00-03:00",
                    "companyIdAccountManagement": 1,
                    "accountManagementInactive": 0,
                    "accountManagementCode": "5.02",
                    "apportionmentId": 1109,
                    "entryNumberId": 12768,
                    "value": 320.00,
                    "percentual": "32,000000000000000000"
                }
            ],
            "valuesCurrencies": [
                {
                    "companyId": 1,
                    "entryNumberId": 12768,
                    "currency": "$",
                    "value": 5000.0000
                },
                {
                    "companyId": 1,
                    "entryNumberId": 12768,
                    "currency": "€",
                    "value": 7000.0000
                }
            ],
            "apportionmentValuesCurrencies": [
                {
                    "companyId": 1,
                    "apportionmentId": 1108,
                    "currency": "$",
                    "value": 3400.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1108,
                    "currency": "€",
                    "value": 4760.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1109,
                    "currency": "$",
                    "value": 1600.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1109,
                    "currency": "€",
                    "value": 2240.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1106,
                    "currency": "$",
                    "value": 4000.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1106,
                    "currency": "€",
                    "value": 5600.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1107,
                    "currency": "$",
                    "value": 1000.0000
                },
                {
                    "companyId": 1,
                    "apportionmentId": 1107,
                    "currency": "€",
                    "value": 1400.0000
                }
            ]
        }
    ]
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
themeFadeToGrey
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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, 8).\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, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', 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, 28, null, null, , null, null, null, 8, 'mestre', '26/03/2024 09:38:59', 'mestre', '26/03/2024 09:38:59', null, null, 0)",
            "detailedMessage": null,
            "helpUrl": null,
            "details": null
        }
    ]
}