Versões comparadas

Chave

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

...

Informações
iconfalse

As tabelas abaixo são divididas da seguinte maneira:

  • Campo: Identificação do campo no Json.
  • Identificador: Identificação do campo no banco de dados RM correspondente ao campo Json.
  • Tipo: Tipo de valor aceito no campo, podendo ser numérico (Int, Decimal), condicionais (Boolean), texto (String, Datetime), além do tipo List, para esse último, é esperado uma nova sequência de dados (Bloco interno).
  • Descrição: Fornece uma descrição do campo.
  • Obrigatório: Especifica se a informação é obrigatória durante operações de envio (POST, PUT, PATCH). Caso a informação seja obrigatória condicionalmente essa informação será descrita no campo Observação.
  • Observação: Informações condicionais ou importantes para o funcionamento da API serão apresentadas nesse campo.

Informações
iconfalse
Expandir
Lote
titleSolicitação

Tipo: POST

CodColigadaPOSTCodLote-
Lote
Campo
Identificador
TipoDescriçãoObrigatórioObservação
CodColigada
Expandir
titleLotes
Lote
CampoTipoDescriçãoObservação

CompanyId

IntCódigo da Coligada
-
BatchId
CodLote
IntCódigo do Lote
POST
-
ListaLista com os lotes que serão processados

Sim

-
MessageStringObservação, complemento, mensagem a ser enviada junto ao e-mailNãoO campo é opcional, sendo utilizado no corpo do email.

2 - Métodos

...

      Métodos disponíveis na API de Solicitação de Aprovação de Lotes:

Informações
iconfalse
Informações
iconfalse
Expandir
titlePost (Inserir um Lançamento e PartidaSolicitar Aprovação do Lote)

POST: Solicita a Aprovação dos Lotes enviados

Informações
iconfalse
titlePost

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/ctb/v1/lotLancApprovalbatchLancApproval/requestApproval

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

O JSON abaixo contém os dados para solicitar a aprovação de um Lote ContábilLotes Contábeis.

Bloco de código
languagejs
themeEmacs
firstline1
titleResultado (JSON)
linenumberstrue
[
   {
      "CodColigadaMessage":1,
      "CodLote":0
   }
]
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,"Teste envio de email", 
    "batchCode": 0,
    "description": "Inclusão de Lançamento VIA API com rateio - POST",
    "accountEntry""BatchList": [
        {
            "entryNumberIdCompanyId": 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",
    BatchId": 99
            "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": [
  ]
   }
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...

Na resposta do resultado, são retornadas as informações dos Lotes que foram processados com sucesso.

Bloco de código
languagejs
themeRDark
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": true,
    "items": [
              {
                    "companyIdcodColigada": 1,
                    "entryNumberId"codLote": 1276877,
                    "currencydescricao": "$",
Lote gerado pelo processo de Rateio -              "value": 5000.0000
                }LONDON ROYAL",
                {
                    "companyId": 1,
                    "entryNumberId": 12768,
                    "currency": "€",
                    "value": 7000.0000"status": "Success"
                }
            ],
            "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
                }
            ]
        }
    ]
}"total": 1
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
themeFadeToGrey
firstline1
titleResultado (JSON)
linenumberstrue
{
    "codehasNext": "FE006"true,
    "messageitems": "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": [[
        {
            "codColigada": 1,
        {
            "code"codLote": "Exception"30,
            "messagedescricao": "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.Lote 1.2.01/1.2.02 do RMNucleus",
            "detailedMessagestatus": null,
            "helpUrl": null"Error",
            "detailsmensagem": [
                {
                    "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"O Lote 30 da Coligada 1 não pertence ao TOTVS Gestão Contábil."
                }
            ]
        },
        {
            "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
        }
    ]"total": 1
}