Especificação API

Restrições

  • Limite de registros: 300.
  • Acesso via SmartAPI

Request Headers 

    • AMBIENTE:
    • Ocp-Apim-Subscription-Key:

Token

Bearer Token: Token


URL

POST<URL_BASE>/Titulo/ImportacaoTitulos

REQUEST

{
  "cnpj": "string",
  "titulos": [
    {
      "tipo": "string",
      "titulo": 999999999999,
      "atribuicao": "string",
      "duplicata": "string",
      "clienteDoc": "string",
      "tipoCobranca": "string",
      "banco": 99999,
      "origem": 99999,
      "departamento": 999,
      "usuario": "string",
      "dataEmissao": "string",
      "dataVencimento": "string",
      "dataContabil": "string",
      "status": "string",
      "historico": "string",
      "valorTitulo": 9999999.99,
      "nossoNumero": "string",
      "valJurosNg": 9999999.99,
      "valMultaNg": 9999999.99,
      "valDescontoNg": 9999999.99,
      "devolucao": "string"
    }
  ]
}

RESPONSE

StatusCode
 200 - OK 
401 - Unauthorized
403 - Forbidden
400 - Bad Request
500 - Internal Server 

{
    "erros": [
        {
            "tipo": "string",
            "titulo": 999999999999,
            "atribuicao": "string",
            "erro": "string"
        }
    ]
}

Dicionário

fonte: DicionarioDados


REQUEST
CAMPOSTAG (json)OBRIGATÓRIOTIPOTABELACAMPOCONSTRAINTVALIDAÇÕES
cnpjtiposimstring(14)FIN_TITULO

Valida Empresa e Revenda pelo cnpj em GER_REVENDA
Tipo: "CR",tiposimstring(2)FIN_TITULOTIPOTipo=CR:  = Titulos a Receber
Tipo=CP:  = Titulos a Pagar
Tipo=CT: = Cartão Crédito

BC -> Banco

CF -> Conta Corrente Fábrica

CP -> Contas a Pagar

CR -> Contas a Receber

CT -> Cartão de Crédito

CX -> Caixa.

Titulotitulosimint(12)FIN_TITULOTITULO

Atribuicaoatribuicaosimstring(18)FIN_TITULOATRIBUICAO18 posições - Esse campo será atualizado na carga dos titulos, (os titulos gerados pelo frente de caixa, já estarão no Linx, mas sem esse código e será atualizado)
Novo campo na FIN_TITULO
(campo novo)
Campo de origem SAP CR, CP e CT.
Será atualizado na carga de titulos e reenviado após baixa do título
Duplicata:
Número da parcela
duplicatasimstring(2)FIN_TITULODUPLICATA

Documento Cliente clienteDocsimstring(14)FIN_TITULOCLIENTESe Tipo=CR: ClienteDoc = cliente
Se Tipo=CP: ClienteDoc = fornecedor
Se Tipo=CT: ClienteDoc = cliente
Caso algum CPF/CNPJ não esteja cadastrado o título não será importado e este títulos serão listados no retorno.
CPF/CNPJ: maxLength 14
Valida documento em FAT_PESSOA_FISICA e FAT_PESSOA_JURIDICA
TipoCobranca: "S",tipoCobrancasimstring(1)FIN_TITULOTIPO_COBRANCAdefault = S (cobrança Simples) 

C -> Carteira,

S -> Simples,

D -> Desconto

J -> Judicial,

K -> Caução,

P -> Pagamento por conta,

V -> Vendor . 

Banco: 0,bancosimint(5)FIN_TITULOBANCOTipo=CR:  = Titulos a Receber
Tipo=CP:  = Titulos a Pagar
Tipo=CT: = Cartão Crédito                                                     O Código do Banco  pode vir default = 900
900 (FIXO)
Origem: 0,origemsimint(5)FIN_TITULOORIGEMFK: FIN_ORIGEM SERÁ TRATADO PELO MIDLEWARE,
Enviaremos o depara das origens de acordo com as condições de pagamentos e despesas que serão lançadas no movimento de caixa. Carrera irá  tratar o depara
DE-PARA Títulos DPA
Departamento: 0,departamentosim3FIN_TITULO
FK: GER_DEPARTAMENTO     
No Linx esse campo é numerico e não aceita zero a esquerda, iremos enviar no nosso formato e Carrera irá formatar para enviar ao SAP
CENTRO DE CUSTO
Usuariousuariosimint(5)FIN_TITULOUSUARIOCriar um usuário DPA para enviar na carga 
Data EmissaodataEmissaosimstringFIN_TITULODTA_EMISSAO
formato: yyyy-MM-ddThh:mm:ss ex: 2025-07-23T09:59:55
Data VencimentodataVencimentosimstringFIN_TITULODTA_VENCIMENTO
formato: yyyy-MM-ddThh:mm:ss ex: 2025-07-23T09:59:55
Data ContábildataContabilsimstringFIN_TITULODTA_CONTABILPode trazer a mesma da Emissão - DataEmissao: "2025-04-03T14:15:00.911Z",formato: yyyy-MM-ddThh:mm:ss ex: 2025-07-23T09:59:55
Statusstatussimstring(2)FIN_TITULOSTATUSNa carga dos titulos, todos que estiverem em abertos Status =   EM -> Emitida/Pendente, Titulos baixados total =  PT -> Paga Totalmente,

CT ->Crédito p/ Transf. 

DE -> Devolvida 

DT -> Débito p/ Transf. 

EM -> Emitida/Pendente 

LP -> Baixa por Lucros e Perdas 

PP -> Paga Parcialmente 

PR -> Prevista 

PT -> Paga Totalmente, 

Historicohistoriconãostring(4000)FIN_TITULOHISTORICO
Descritivo do Histórico.Tamanho: 4000.
ValorTitulo: 0,valorTitulosimnumeric(13,2)FIN_TITULOVAL_TITULO

NossoNumeronossoNumeronãoint(16)FIN_TITULONOSSONUMERO

ValJurosNgvalJurosNgnãonumeric(11,2)FIN_TITULOVAL_JUROS_NGVAL_JUROS_NG: MAS PODERÁ TRAZER SE TIVER
ValMultaNgvalMultaNgnãonumeric(11,2)FIN_TITULOVAL_MULTA_NGVAL_MULTA_NG: MAS PODERÁ TRAZER SE TIVER
ValDescontoNg:valDescontoNgnãonumeric(11,2)FIN_TITULOVAL_DESCONTO_NGVAL_DESCONTO_NG: MAS PODERÁ TRAZER SE TIVER
Devolucaodevolucaonãostring(1)FIN_TITULODEVOLUCAOValores válidos:
S = Sim
N =  Não.
default: N

Título é originado de uma devolução
Ex:
1) Se o CR tiver Devolucao = S, será importado no AutoShop como um CP.
E na baixa será exportado como um CR para o SAP.

2) Se o CP tiver Devolucao = S, será importado no AutoShop como um CR.
E na baixa será exportado como um CP para o SAP.


RESPONSE
StatusCodeCAMPOSTAG (json)OBRIGATÓRIOTIPO
400Tipo: "CR",tipo
string
Titulotitulo
string
Atribuicaoatribuicao
string
Erroerro
string
  • Sem rótulos