Linx Itec - Consolidação de vendas (1.0.0)

Download OpenAPI specification:Download

Essa API é utilizada para consolidação de vendas e outros documentos de loja.

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

api_key

Security Scheme Type API Key
Header parameter name: api_key

receipt

Repositório que receberá o JSON dos documentos

Cupom Fiscal

Envia os documentos do tipo cupom fiscal

Adiciona um novo documento para consolidação

Authorizations:
Request Body schema: application/json

Cupom fiscal para consolidação

tenant
string
origem
string
cnpjFilial
string
id
string
cdCntBancariaPadrao
integer
cdDoc
integer
cancelTef
integer
cdAdmCartao
integer
cdCli
integer
cdCliPbm
integer
cdConv
integer
cdCx
integer
cdCxAdm
integer
cdEmp
integer
cdEcf
integer
cdFilial
integer
cdFilialVdTele
integer
cdLancChq
integer
codigoMovimento
integer
codigoMotivoCancelamento
integer
cdOutroProcedimento
integer
cdUsuProcedimento
integer
cdMtCancel
integer
cdNf
integer
cdNfSerie
integer
cdUsu
integer
cdUsuCancel
integer
cdUsuOpe
integer
cdVd
integer
cdVdLoja
integer
cdCtrNcc
integer
cdCtrConv
integer
cdOperador
integer
cgcCli
string
chvNfce
string
codBandeira
integer
codModalidade
string
codRede
integer
concCartao
integer
contadorCupomFiscal
integer
dadosAdicionais
string
dtCad
string <date-time>
dtCadStr
string
dtConsd
string <date-time>
dtUltAlt
string <date-time>
dtVd
string <date-time>
dtVdAdm
string <date-time>
dtVdf
string <date-time>
dtVdStr
string
endCli
string
flagNfce
integer
hrVd
string <date-time>
hrVdStr
string
nmComprador
string
nmOperCel
string
nrAutorizacao
string
nrCartaoMarka
string
nrCartaoMarka4
string
nrCartaoMarka2
string
nrCelRecarga
string
nrEcf
integer
nrEcfAdm
integer
nrSerieEcf
string
nrOperCel
number
nrOrc
number
nrPedTelevd
integer
nsuConvExt
number
obs
string
origemOrc
integer
percIbpt
number
percRecConv
number
qtParcConv
integer
regAlterado
integer
respImpDadosConsumidor
integer
stCancPaf
integer
stImport
integer
stVd
integer
tpEmis
integer
stsOrcPendTelevd
integer
tipo
integer
tpMsg
integer
tpPercRecConv
number
valorIbpt
number
vdTrocaFidel
integer
vincChq
integer
vlrCartao
number
vlrConv
number
vlrChqs
number
vlrConvPbm
number
vlrCrediario
number
vlrDesc
number
vlrDescItens
number
vlrDinh
number
vlrDup
number
vlrLiqVd
number
vlrNcc
number
vlrRecargaCel
number
vlrSaqueCartao
number
vlrTickets
number
vlrTotProd
number
vlrTrocoChq
number
vlrTroco
number
valorChequeAVista
number
valorChequeAPrazo
number
vlrVd
number
vsConsolidador
string
vsPdv
string
vsPdvRc
string
numeroCartao
string
diasProrrogConv
integer
isDebitarPontos
integer
versaoPdv
string
versaoPdvRc
string
contemDinheiro
boolean
contemConvenio
boolean
contemDuplicata
boolean
contemNcc
boolean
contemRecargaCel
boolean
isCancelado
boolean
isCanceladoPaf
boolean
registroalterado
boolean
percentualIbpt
number
flagConsolidado
integer
cdNfSai
integer
cdOrc
integer
qtdePontosFidelExterno
number
totalDescVerba
number
nrTelCupom
string
nrMfe
integer
importado
integer
nrEcfUuid
string
receiptUri
string
rzCli
string
nmOperador
string
origVenda
string
cdSaiSngpc
string
cdVdDev
integer
cdVdDevNf
integer
cdVend
integer
cdVendVerba
integer
descFixadoCad
string
vlChqsAprz
number
codRed
integer
cancelUuid
string
tpCupom
integer
artificial
boolean
uuid
string
chequeId
integer
parcAtual
integer
dtFecha
string <date-time>
dtFechaStr
string
vlrParcela
number
nsuVnd
string
vlrFreteTot
number
cdParceiro
integer
cpfClienteParceiro
string
nomeClienteParceiro
string
nrAutorizaConv
string
updateCupom
string
object (NfceCancel)
Array of objects (Receita)
object (Orcamento)
object (pagamento)
object (nfce)
object (item)
object (CupomNaoFiscal)
object (endereco)
object (vouchers)

Responses

Request samples

Content type
application/json
{
  • "tenant": "string",
  • "origem": "string",
  • "cnpjFilial": "string",
  • "id": "string",
  • "cdCntBancariaPadrao": 0,
  • "cdDoc": 0,
  • "cancelTef": 0,
  • "cdAdmCartao": 0,
  • "cdCli": 0,
  • "cdCliPbm": 0,
  • "cdConv": 0,
  • "cdCx": 0,
  • "cdCxAdm": 0,
  • "cdEmp": 0,
  • "cdEcf": 0,
  • "cdFilial": 0,
  • "cdFilialVdTele": 0,
  • "cdLancChq": 0,
  • "codigoMovimento": 0,
  • "codigoMotivoCancelamento": 0,
  • "cdOutroProcedimento": 0,
  • "cdUsuProcedimento": 0,
  • "cdMtCancel": 0,
  • "cdNf": 0,
  • "cdNfSerie": 0,
  • "cdUsu": 0,
  • "cdUsuCancel": 0,
  • "cdUsuOpe": 0,
  • "cdVd": 0,
  • "cdVdLoja": 0,
  • "cdCtrNcc": 0,
  • "cdCtrConv": 0,
  • "cdOperador": 0,
  • "cgcCli": "string",
  • "chvNfce": "string",
  • "codBandeira": 0,
  • "codModalidade": "string",
  • "codRede": 0,
  • "concCartao": 0,
  • "contadorCupomFiscal": 0,
  • "dadosAdicionais": "string",
  • "dtCad": "2019-08-24T14:15:22Z",
  • "dtCadStr": "string",
  • "dtConsd": "2019-08-24T14:15:22Z",
  • "dtUltAlt": "2019-08-24T14:15:22Z",
  • "dtVd": "2019-08-24T14:15:22Z",
  • "dtVdAdm": "2019-08-24T14:15:22Z",
  • "dtVdf": "2019-08-24T14:15:22Z",
  • "dtVdStr": "string",
  • "endCli": "string",
  • "flagNfce": 0,
  • "hrVd": "2019-08-24T14:15:22Z",
  • "hrVdStr": "string",
  • "nmComprador": "string",
  • "nmOperCel": "string",
  • "nrAutorizacao": "string",
  • "nrCartaoMarka": "string",
  • "nrCartaoMarka4": "string",
  • "nrCartaoMarka2": "string",
  • "nrCelRecarga": "string",
  • "nrEcf": 0,
  • "nrEcfAdm": 0,
  • "nrSerieEcf": "string",
  • "nrOperCel": 0,
  • "nrOrc": 0,
  • "nrPedTelevd": 0,
  • "nsuConvExt": 0,
  • "obs": "string",
  • "origemOrc": 0,
  • "percIbpt": 0,
  • "percRecConv": 0,
  • "qtParcConv": 0,
  • "regAlterado": 0,
  • "respImpDadosConsumidor": 0,
  • "stCancPaf": 0,
  • "stImport": 0,
  • "stVd": 0,
  • "tpEmis": 0,
  • "stsOrcPendTelevd": 0,
  • "tipo": 0,
  • "tpMsg": 0,
  • "tpPercRecConv": 0,
  • "valorIbpt": 0,
  • "vdTrocaFidel": 0,
  • "vincChq": 0,
  • "vlrCartao": 0,
  • "vlrConv": 0,
  • "vlrChqs": 0,
  • "vlrConvPbm": 0,
  • "vlrCrediario": 0,
  • "vlrDesc": 0,
  • "vlrDescItens": 0,
  • "vlrDinh": 0,
  • "vlrDup": 0,
  • "vlrLiqVd": 0,
  • "vlrNcc": 0,
  • "vlrRecargaCel": 0,
  • "vlrSaqueCartao": 0,
  • "vlrTickets": 0,
  • "vlrTotProd": 0,
  • "vlrTrocoChq": 0,
  • "vlrTroco": 0,
  • "valorChequeAVista": 0,
  • "valorChequeAPrazo": 0,
  • "vlrVd": 0,
  • "vsConsolidador": "string",
  • "vsPdv": "string",
  • "vsPdvRc": "string",
  • "numeroCartao": "string",
  • "diasProrrogConv": 0,
  • "isDebitarPontos": 0,
  • "versaoPdv": "string",
  • "versaoPdvRc": "string",
  • "contemDinheiro": true,
  • "contemConvenio": true,
  • "contemDuplicata": true,
  • "contemNcc": true,
  • "contemRecargaCel": true,
  • "isCancelado": true,
  • "isCanceladoPaf": true,
  • "registroalterado": true,
  • "percentualIbpt": 0,
  • "flagConsolidado": 0,
  • "cdNfSai": 0,
  • "cdOrc": 0,
  • "qtdePontosFidelExterno": 0,
  • "totalDescVerba": 0,
  • "nrTelCupom": "string",
  • "nrMfe": 0,
  • "importado": 0,
  • "nrEcfUuid": "string",
  • "receiptUri": "string",
  • "rzCli": "string",
  • "nmOperador": "string",
  • "origVenda": "string",
  • "cdSaiSngpc": "string",
  • "cdVdDev": 0,
  • "cdVdDevNf": 0,
  • "cdVend": 0,
  • "cdVendVerba": 0,
  • "descFixadoCad": "string",
  • "vlChqsAprz": 0,
  • "codRed": 0,
  • "cancelUuid": "string",
  • "tpCupom": 0,
  • "artificial": true,
  • "uuid": "string",
  • "chequeId": 0,
  • "parcAtual": 0,
  • "dtFecha": "2019-08-24T14:15:22Z",
  • "dtFechaStr": "string",
  • "vlrParcela": 0,
  • "nsuVnd": "string",
  • "vlrFreteTot": 0,
  • "cdParceiro": 0,
  • "cpfClienteParceiro": "string",
  • "nomeClienteParceiro": "string",
  • "nrAutorizaConv": "string",
  • "updateCupom": "string",
  • "nfceCancel": {
    },
  • "receita": [
    ],
  • "orcamento": {
    },
  • "pagamento": {
    },
  • "nfce": {
    },
  • "itens": {
    },
  • "doacao": {
    },
  • "endereco": {
    },
  • "vouchers": {
    }
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "receiptId": "string",
  • "recDate": "2019-08-24T14:15:22Z"
}

Cancelamento de cupom fiscal

Adiciona um novo documento para cancelar um cupom existente

Authorizations:
Request Body schema: application/json

Cancelamento de cupom fiscal existente

nrEcfUuid
string
cdUsuCancel
integer
cancelUuid
string
tenant
string
receiptUri
string
nrEcf
integer
cdEmp
integer
cdFilial
integer
cdCx
integer
dtVd
string <date-time>
dtVdStr
string
flagNfce
integer
object (NfceCancel)

Responses

Request samples

Content type
application/json
{
  • "nrEcfUuid": "string",
  • "cdUsuCancel": 0,
  • "cancelUuid": "string",
  • "tenant": "string",
  • "receiptUri": "string",
  • "nrEcf": 0,
  • "cdEmp": 0,
  • "cdFilial": 0,
  • "cdCx": 0,
  • "dtVd": "2019-08-24T14:15:22Z",
  • "dtVdStr": "string",
  • "flagNfce": 0,
  • "nfceCancel": {
    }
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "receiptId": "string",
  • "recDate": "2019-08-24T14:15:22Z"
}

Adiciona um novo documento de mapa resumo gerencial

Adiciona um novo documento de mapa resumo gerencial

Authorizations:
Request Body schema: application/json

Mapa resumo gerencial

tipoRegistro
string
cdEmp
integer
cdFilial
integer
cdCtr
integer
dtEcf
integer <date-time>
dtEcfStr
string
cdCx
integer
stVd
integer
dtCad
integer <date-time>
dtCadStr
string
hrCad
integer <date-time>
contRedZ
integer
cooReducaoZ
integer
contOrdOpIni
integer
contOrdOpFin
integer
contReinicioOp
integer
gtIni
number
gtFin
number
vlrVendaBruta
number
vlrDesc
number
vlrCanc
number
vlrContab
number
vlrIcms
number
vlrIsentas
number
vlrNaoTrib
number
vlrBaseIcmsSubs
number
vlrIssqn
number
vlrDescIssqn
number
vlrCancelIssqn
number
txIcms
number
baseCalc
number
tipoImposto
integer
vlrTxIcms
number
nrEcfUuid
string
receiptUri
string
tenant
string
uuid
string
flagNfce
integer
Array of objects (Aliquotas)

Responses

Request samples

Content type
application/json
{
  • "tipoRegistro": "string",
  • "cdEmp": 0,
  • "cdFilial": 0,
  • "cdCtr": 0,
  • "dtEcf": 0,
  • "dtEcfStr": "string",
  • "cdCx": 0,
  • "stVd": 0,
  • "dtCad": 0,
  • "dtCadStr": "string",
  • "hrCad": 0,
  • "contRedZ": 0,
  • "cooReducaoZ": 0,
  • "contOrdOpIni": 0,
  • "contOrdOpFin": 0,
  • "contReinicioOp": 0,
  • "gtIni": 0,
  • "gtFin": 0,
  • "vlrVendaBruta": 0,
  • "vlrDesc": 0,
  • "vlrCanc": 0,
  • "vlrContab": 0,
  • "vlrIcms": 0,
  • "vlrIsentas": 0,
  • "vlrNaoTrib": 0,
  • "vlrBaseIcmsSubs": 0,
  • "vlrIssqn": 0,
  • "vlrDescIssqn": 0,
  • "vlrCancelIssqn": 0,
  • "txIcms": 0,
  • "baseCalc": 0,
  • "tipoImposto": 0,
  • "vlrTxIcms": 0,
  • "nrEcfUuid": "string",
  • "receiptUri": "string",
  • "tenant": "string",
  • "uuid": "string",
  • "flagNfce": 0,
  • "aliquotas": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "receiptId": "string",
  • "recDate": "2019-08-24T14:15:22Z"
}

Obtem um documento e status pelo ID

Obtem um documento e status pelo ID

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "json": "string",
  • "type": "string",
  • "recDate": "2019-08-24T14:15:22Z",
  • "startProcDate": "2019-08-24T14:15:22Z",
  • "statusDate": "2019-08-24T14:15:22Z",
  • "user": "string",
  • "tenant": "string",
  • "status": 0,
  • "error": "string",
  • "receiptUri": "string",
  • "linkId": "string",
  • "duplicated": true
}