> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/consulta-de-escrituracoes/lancamentos-contabeis-por-contrato.md).

# Lançamentos Contábeis por Contrato

Retorna os lançamentos contábeis Dataprev (descontos em folha declarados pelo empregador) de um contrato seu.

## Request

`GET /api/v1/originator/contracts/{contractPublicId}/dataprev/bookkeeping-entries`

Requer autenticação: `Authorization: Bearer {originatorToken}`.

### Parâmetros

| Parâmetro          | Local | Tipo            | Obrigatório | Descrição                         |
| ------------------ | ----- | --------------- | ----------- | --------------------------------- |
| `contractPublicId` | path  | `string (uuid)` | Sim         | Identificador público do contrato |

## Response

Array sem paginação. Cada item segue o schema de [Lançamentos Contábeis Global](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/consulta-de-escrituracoes/lancamentos-contabeis-global.md#item-content), inclusive o tratamento de [desconto dividido em mais de um lançamento](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/consulta-de-escrituracoes/lancamentos-contabeis-global.md#desconto-dividido-em-mais-de-um-lancamento).

* **200 OK** — lançamentos retornados (array vazio quando não há lançamentos).
* **404 Not Found** — contrato não encontrado ou de outro originador.

## Exemplo

```http
GET /api/v1/originator/contracts/0198f29c-1a55-7c40-8e13-9b2d4f6a0c18/dataprev/bookkeeping-entries HTTP/1.1
Host: api.giro.tech
Authorization: Bearer {originatorToken}
```

Resposta `200`:

```json
[
  {
    "dataprevId": 456789,
    "contractNumber": "00345678",
    "referencePeriod": 202404,
    "deductionAmount": 593.78,
    "eventDeductionAmount": 593.78,
    "eventEntryCount": 1,
    "eventEntries": [
      { "publicId": "0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b02", "dataprevId": 456789, "deductionAmount": 593.78 }
    ],
    "includedAtDataprev": "2024-04-30T12:00:00Z",
    "eSocialEventId": "1065346190000002026070811274100003",
    "employerRegistrationNumber": "06534619"
  }
]
```

## Erros

| Código | Situação                                       |
| ------ | ---------------------------------------------- |
| 401    | Token ausente, expirado ou inválido            |
| 403    | Token válido sem permissão para este recurso   |
| 404    | Contrato não encontrado ou de outro originador |

Formato dos erros: [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.md).

## Listar lançamentos contábeis por contrato

> Retorna os lançamentos contábeis Dataprev do contrato informado (do originador autenticado).

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Dataprev","description":"Dados Dataprev (transferências de pagamento e lançamentos contábeis)"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/contracts/{contractPublicId}/dataprev/bookkeeping-entries":{"get":{"summary":"Listar lançamentos contábeis por contrato","description":"Retorna os lançamentos contábeis Dataprev do contrato informado (do originador autenticado).","tags":["Dataprev"],"parameters":[{"name":"contractPublicId","in":"path","required":true,"description":"Identificador do contrato: aceita o id numerico ou o publicId opaco do contrato.\n","schema":{"type":"string","maxLength":36}}],"responses":{"200":{"description":"Lista de lançamentos retornada com sucesso","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","deprecated":true,"description":"**Deprecated.** Chave interna da plataforma (auto-incremento), exposta na resposta sem garantia\nde contrato: não use como identificador nem grave na sua base. Será removido em uma versão\nfutura; use `publicId`.\n"},"publicId":{"type":"string","maxLength":36,"description":"Identificador publico opaco. Presente nos registros novos; omitido (ausente no JSON) enquanto\no registro é antigo. Trate como string opaca.\n"},"dataprevId":{"type":"integer","format":"int64"},"contractNumber":{"type":"string","description":"Número do contrato (8 dígitos com zero à esquerda).\nPor padrão (estratégia GIRO), gerado pela plataforma; na estratégia ORIGINATOR_MANAGED, pode ser informado pelo originador.\n"},"referencePeriod":{"type":"integer"},"deductionAmount":{"type":"number","format":"decimal","description":"Valor da dedução em reais (decimal com 2 casas decimais)."},"eventDeductionAmount":{"type":"number","format":"decimal","description":"Soma de `deductionAmount` das linhas com o mesmo `eSocialEventId`, contrato e competência —\no desconto efetivo da folha naquele evento. O empregador pode dividir o desconto da parcela\nem mais de uma rubrica do mesmo S-1200, e cada rubrica chega como um lançamento separado.\n\nCompare `eventDeductionAmount` com `loanInstallmentValue` para saber se a parcela foi\ndescontada inteira. `analysisInstallmentValueCorrect` é o veredito da Dataprev **por\nlançamento** e fica `false` em cada parte de um desconto dividido, mesmo quando a soma bate.\n\nIgual a `deductionAmount` quando o evento tem um lançamento só.\n"},"eventEntryCount":{"type":"integer","format":"int64","description":"Quantos lançamentos compõem o evento. `1` quando o desconto não foi dividido."},"eventEntries":{"type":"array","description":"Os lançamentos que compõem o evento, inclusive este, ordenados por `dataprevId`. Cada item\ndo evento traz a mesma lista, então as partes ficam visíveis mesmo quando caem em páginas\ndiferentes da consulta global. Um item só quando o desconto não foi dividido.\n","items":{"type":"object","description":"Um lançamento que compõe o desconto de um evento eSocial.","properties":{"publicId":{"type":"string","maxLength":36,"description":"Identificador público do lançamento. Pode vir ausente em registros antigos."},"dataprevId":{"type":"integer","format":"int64"},"deductionAmount":{"type":"number","format":"decimal","description":"Valor descontado nesta rubrica."}}}},"includedAtDataprev":{"type":"string","format":"date-time"},"ingestedAt":{"type":"string","format":"date-time","nullable":true,"description":"Instante em que a plataforma gravou a linha (UTC). Não confundir com `includedAtDataprev`, o\ncarimbo da própria Dataprev, que pode chegar com dias de atraso: para sincronização incremental\nuse este campo, via o filtro `ingestedFrom`.\n\nVem `null` nas linhas gravadas antes de o carimbo existir — elas não aparecem no filtro\n`ingestedFrom`. É carimbo de inserção: uma correção feita depois na linha não muda o valor.\n"},"eSocialEventId":{"type":"string","maxLength":50},"dataMatch":{"type":"boolean"},"eventTypeCode":{"type":"integer"},"institutionCode":{"type":"integer"},"cpf":{"type":"string"},"registrationNumber":{"type":"string"},"employerTaxIdType":{"type":"string","enum":["CNPJ","CPF"],"nullable":true,"description":"Tipo do documento do empregador em `employerRegistrationNumber`."},"employerRegistrationNumber":{"type":"string","maxLength":14},"loanInstitutionCode":{"type":"integer"},"loanInstallmentValue":{"type":"number","format":"decimal"},"analysisContractBooked":{"type":"boolean"},"analysisWorkerBooked":{"type":"boolean"},"analysisInstitutionCorrect":{"type":"boolean"},"analysisInstallmentValueCorrect":{"type":"boolean"},"analysisLinkCorrect":{"type":"boolean"},"exclusionEventDatetime":{"type":"string"},"correctionEventDatetime":{"type":"string"},"exclusionEventId":{"type":"string","maxLength":50},"correctionEventId":{"type":"string","maxLength":50},"eventTypeDescription":{"type":"string","nullable":true,"maxLength":255,"description":"Descrição de `tipoEventoESocial` dada pela Dataprev, ao lado do código já existente."},"employerRegistrationTypeDescription":{"type":"string","nullable":true,"maxLength":255,"description":"Descrição de `inscricaoEmpregador`, ao lado do código já existente."},"status":{"type":"string","enum":["ACTIVE","CORRECTED","EXCLUDED"],"description":"Vigência do lançamento, derivada de `exclusionEventId` e `correctionEventId`. A Dataprev não\nmarca qual linha vale: cada reenvio do S-1200 para a mesma competência entra como lançamento\nnovo, e o anterior passa a apontar o evento que o substituiu.\n\n- `ACTIVE`: lançamento vigente — é o que deve ser considerado.\n- `CORRECTED`: retificado; `correctionEventId` traz o `eSocialEventId` do sucessor, que está\n  na mesma listagem.\n- `EXCLUDED`: excluído pelo evento S-3000 em `exclusionEventId`. Pode não haver substituto —\n  nesse caso a competência fica sem lançamento vigente.\n\nNão use recência (`dataprevId` ou `includedAtDataprev`) para escolher o lançamento vigente:\na ordem de chegada não acompanha a ordem dos eventos, e `includedAtDataprev` empata entre\nlançamentos da mesma carga diária. Duas linhas `ACTIVE` com o mesmo `eSocialEventId` são\ndescontos parciais da mesma competência e **somam** — não são versões.\n"}}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Contrato não encontrado ou não pertence ao originador","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
