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 | |||||||
CAMPOS | TAG (json) | OBRIGATÓRIO | TIPO | TABELA | CAMPO | CONSTRAINT | VALIDAÇÕES |
cnpj | tipo | sim | string(14) | FIN_TITULO | Valida Empresa e Revenda pelo cnpj em GER_REVENDA | ||
Tipo: "CR", | tipo | sim | string(2) | FIN_TITULO | TIPO | Tipo=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. |
Titulo | titulo | sim | int(12) | FIN_TITULO | TITULO | ||
Atribuicao | atribuicao | sim | string(18) | FIN_TITULO | ATRIBUICAO | 18 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 | duplicata | sim | string(2) | FIN_TITULO | DUPLICATA | ||
Documento Cliente | clienteDoc | sim | string(14) | FIN_TITULO | CLIENTE | Se 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", | tipoCobranca | sim | string(1) | FIN_TITULO | TIPO_COBRANCA | default = S (cobrança Simples) | C -> Carteira, S -> Simples, D -> Desconto J -> Judicial, K -> Caução, P -> Pagamento por conta, V -> Vendor . |
Banco: 0, | banco | sim | int(5) | FIN_TITULO | BANCO | Tipo=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, | origem | sim | int(5) | FIN_TITULO | ORIGEM | FK: 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, | departamento | sim | 3 | FIN_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 | |
Usuario | usuario | sim | int(5) | FIN_TITULO | USUARIO | Criar um usuário DPA para enviar na carga | |
Data Emissao | dataEmissao | sim | string | FIN_TITULO | DTA_EMISSAO | formato: yyyy-MM-ddThh:mm:ss ex: 2025-07-23T09:59:55 | |
Data Vencimento | dataVencimento | sim | string | FIN_TITULO | DTA_VENCIMENTO | formato: yyyy-MM-ddThh:mm:ss ex: 2025-07-23T09:59:55 | |
Data Contábil | dataContabil | sim | string | FIN_TITULO | DTA_CONTABIL | Pode 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 |
Status | status | sim | string(2) | FIN_TITULO | STATUS | Na 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, |
Historico | historico | não | string(4000) | FIN_TITULO | HISTORICO | Descritivo do Histórico.Tamanho: 4000. | |
ValorTitulo: 0, | valorTitulo | sim | numeric(13,2) | FIN_TITULO | VAL_TITULO | ||
NossoNumero | nossoNumero | não | int(16) | FIN_TITULO | NOSSONUMERO | ||
ValJurosNg | valJurosNg | não | numeric(11,2) | FIN_TITULO | VAL_JUROS_NG | VAL_JUROS_NG: MAS PODERÁ TRAZER SE TIVER | |
ValMultaNg | valMultaNg | não | numeric(11,2) | FIN_TITULO | VAL_MULTA_NG | VAL_MULTA_NG: MAS PODERÁ TRAZER SE TIVER | |
ValDescontoNg: | valDescontoNg | não | numeric(11,2) | FIN_TITULO | VAL_DESCONTO_NG | VAL_DESCONTO_NG: MAS PODERÁ TRAZER SE TIVER | |
Devolucao | devolucao | não | string(1) | FIN_TITULO | DEVOLUCAO | Valores válidos: S = Sim N = Não. default: N | Título é originado de uma devolução |
RESPONSE | ||||
StatusCode | CAMPOS | TAG (json) | OBRIGATÓRIO | TIPO |
400 | Tipo: "CR", | tipo | string | |
Titulo | titulo | string | ||
Atribuicao | atribuicao | string | ||
Erro | erro | string |