API de Conciliação

O relatório de Conciliação poderá ser solictado pela API abaixo e estará disponível no bucket de cada participante. Para que você tenha acesso, entre em contato com o time de Operações para que eles possam cadastrar essa interface.

O relatório ficará disponível na pasta: duplicatas/conciliacao/saida/yyyy/MM/dd com a seguinte nomenclatura: CERC-DPL011_(cnpj-base)(AAMMDD)(SEQ).csv

A geração do arquivo ocorre diariamente às 22h30.

Busca de conciliações de Duplicatas pelo financiador

get

Este endpoint busca conciliações de Duplicatas pelo financiador com base no filtro fornecido

Query parameters

participantDocumentstringRequired

CNPJ do financiador

Example: 00000000000000

referenceDateListstringRequired

Lista de datas separada por ponto e vírgula

Example: 2024-08-01;2024-08-01

walletstringOptional

Código da carteira

Example: codigoDaCarteira

statusstringOptional

Status da conciliação que pode ser CONCILIADO ou PENDENTE

Example: CONCILIADO

Responses

200

*/*

get

GET /publisher/electronic-invoice/v1/conciliations HTTP/1.1
Host: api.stg.cerc.com
Accept: */*

200

[
  {
    "referenceDate": "text",
    "status": {
      "id": "text",
      "description": "text"
    },
    "invoices": {
      "walletCount": 1,
      "stockCount": 1,
      "stockValue": 1
    },
    "conciliationData": [
      {
        "id": "text",
        "calculationDate": "text",
        "creationDate": "text",
        "processingDate": "text",
        "wallet": "text",
        "serviceInvoiceCount": "text",
        "mercantileInvoiceCount": "text",
        "serviceInvoiceTotal": "text",
        "mercantileInvoiceTotal": "text",
        "contractCountTotal": "text",
        "contractValueTotal": "text",
        "status": "text",
        "conciliationUser": {
          "name": "text",
          "companyDocument": "text",
          "userDocumentNumber": "text"
        }
      }
    ]
  }
]

Realiza a conciliação de Duplicatas do financiador com base no filtro fornecido

put

Realiza a conciliação de Duplicatas do financiador

Body

cnpjFinanciadorstringRequired

Responses

200

Retorno de sucesso

application/json

403

Sem permissão

application/json

404

Nenhuma conciliação encontrada para conciliar

application/json

put

PUT /publisher/electronic-invoice/v1/conciliations HTTP/1.1
Host: api.stg.cerc.com
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "participantDocument": "12345678912345",
  "walletsToConciliate": [
    {
      "referenceDate": "2024-08-11",
      "walletList": [
        "carteira1",
        "carteira2"
      ]
    }
  ]
}

{
  "message": "Carteiras conciliadas com sucesso!",
  "walletsConciliated": [
    {
      "referenceDate": "2024-09-06",
      "walletList": [
        "carteira_1"
      ]
    }
  ]
}

Relatorio de conciliacao

get

Este endpoint busca as solicitacoes de relatorio de conciliacao do participante

Query parameters

operationIdstring · uuidOptional

Id da operação

Example: 2bc349a8-d215-44d0-b895-beb51bf277a9

participantDocumentstringOptional

CNPJ do participante

Example: 00000000000000

requesterstringOptional

CNPJ do solicitante

Example: 00000000000000

statusstringOptional

status

Example: PENDING ou COMPLETED

externalReferencestringOptional

Referência Externa

Example: referencia_externa

startDatestringOptional

Data de Inicio

Example: 2024-07-28

endDatestringOptional

Data Fim

Example: 2024-07-29

traceIdstringOptional

Id de Rastreamento

Example: 6a3329a1-d715-44d0-b895-beb51bf850b1

pageinteger · int32Optional

Número da página

Default: 0Example: 0

linePerPageinteger · int32Optional

Total de dados por página

Default: 10Example: 10

orderstringOptional

Campo referência para ordenação

Default: requestDateExample: requestDate

directionstringOptional

Forma de ordenação (ASC ou DESC)

Default: ASCExample: ASC

Responses

200

*/*

get

GET /publisher/electronic-invoice/v1/conciliations/report HTTP/1.1
Host: api.stg.cerc.com
Accept: */*

200

{
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "id": "text",
      "participantDocument": "text",
      "requester": "text",
      "externalReference": "text",
      "operationId": "text",
      "statusReport": "text",
      "completionDate": "text",
      "requestDate": "text"
    }
  ],
  "number": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "first": true,
  "last": true,
  "pageable": {
    "offset": 1,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageSize": 1,
    "pageNumber": 1,
    "paged": true,
    "unpaged": true
  },
  "empty": true
}

Relatório de conciliação

post

Este endpoint faz a solicitação do relatório de conciliação

Body

participantDocumentstringRequired

externalReferencestring · max: 1000Required

walletListstring[]Required

referenceDateListstring[]Required

Responses

200

Retorno de sucesso

application/json

400

Erro ao realizar requisição

application/json

post

POST /publisher/electronic-invoice/v1/conciliations/report HTTP/1.1
Host: api.stg.cerc.com
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "participantDocument": "00000000000000",
  "externalReference": "referencia_externa",
  "walletList": [
    "carteira1",
    "carteira2"
  ],
  "referenceDateList": [
    "2024-08-17",
    "2024-08-12",
    "2024-08-18"
  ]
}

{
  "id": "cde239e3-2cd9-4521-831e-1caf1da5b2de",
  "message": "Relatório solicitado com sucesso"
}

Relatório de conciliação

get

Este endpoint busca uma solicitação pelo id da operação

Path parameters

idstring · uuidRequired

Id do relatório gerado após a solicitação (UUID)

Example: abc12345-d215-44d0-b895-beb51bf277a0

Responses

200

Relatório encontrado

application/json

404

Relatório não encontrado

application/json

get

GET /publisher/electronic-invoice/v1/conciliations/report/{id} HTTP/1.1
Host: api.stg.cerc.com
Accept: */*

{
  "id": "abc12345-d215-44d0-b895-beb51bf277a0",
  "externalReference": "20240818_teste",
  "operationId": "b15ada7a-e154-432b-15dc-43c2595237c2",
  "statusReport": "COMPLETED",
  "completionDate": "2024-08-21",
  "requestDate": "2024-08-21 15:23:57.703606",
  "participantDocument": "12345667000118",
  "requester": "12345667000118"
}

Busca o status dos dias do mês das conciliações de duplicatas do financiador

get

Este endpoint busca o status dos dias com base no ano-mês e documento do participante fornecidos

Query parameters

requestMonthstringRequired

Ano e mês para buscar dias pendentes

Example: 2024-08

participantDocumentstringRequired

CNPJ do financiador

Example: 00000000000000

Responses

200

Retorno de sucesso

application/json

403

Erro de permissão ao tentar consulta um documento do participante inválido

application/json

get

GET /publisher/electronic-invoice/v1/conciliations/periods HTTP/1.1
Host: api.stg.cerc.com
Accept: */*

[
  {
    "referenceDate": "2024-08-01",
    "pendingItemCount": "1",
    "conciliatedItemCount": "16",
    "totalItemCount": "16",
    "status": "CONCILIADO",
    "walletList": [
      "carteira_1",
      "carteira_2",
      "carteira_3"
    ]
  }
]

PreviousBusca de Cancelamentos de Registro NextAPI Webhook

Last updated 1 day ago