O objetivo dessa API é automatizar o lançamentos de documentos do fluxo de pagamentos no sistema a partir de uma requisição do tipo REST.
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
workflowId*
Integer
Código do tipo de processo onde o documento será lançado
establishment*
Integer
CNPJ do estabelecimento onde o documento será lançado
documentVOList*
Array de objetos
Array de objetos com as propriedades do tipo de documento que será lançado no sistema
documentTypeId*
Integer
Código do tipo de documento onde o documento que será inserido pela API será categorizado no sistema
documentObjetcs*
Array de objetos
Array de objetos com as propriedades do documento que será lançado no sistema
attachments
Array de string
Array de strings onde é passado os anexos que um documento pode ter. Sempre em base 64
indexers*
Array de objetos
Array de objetos que indica quais são os indexadores do processo que será iniciado
sequence*
Integer
Sequência do indexador no processo (pertence a propriedade "indexers")
indexerTypeName*
String
Nome do campo ou label que o indexador possui (pertence a propriedade "indexers")
indexerValue*
String
Valor que o indexador da label acima irá possuir (pertence a propriedade "indexers")
indexerType*
String
Tipo do indexador (pertence a propriedade "indexers"):
I - Inteiro
S - String
V - Valor
L - Lista
D - Data
M - Data múltipla
name*
String
Nome do arquivo que será inserido com sua extensão (ex: arquivo.pdf)
observation
String
Comentário do documento. Pode ser vazio
objectTypeId*
Integer
Sempre será 2
documentObjectAsBase64*
String
Documento em base 64
Aqui estão documentadas todas as nossas APIs públicas relacionadas ao fluxo de pagamentos
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
cnpjNumber*
String
CNPJ do fornecedor da nota fiscal
nfeNumber*
String
Número da nota fiscal
Content-Type*
String
application/json
Authorization*
String
Token de acesso adquirido através da API "Get JWT" (bearer)
documentId
Array de integer
Este parâmetro está em desuso e pode ser passado vazio
establishmentIds
Array de integer
Array de integer que passa os IDs dos estabelecimentos
processTypeIds
Array de integer
Array de integer que passa os códigos dos tipos de processos
documentTypeIds
Array de integer
Array de integer que passa os códigos dos tipos de documentos
initialDate
String
Consulta por data inicial. Deve ser no formato "03/11/2021 10:37:28"
finalDate
String
Consulta por data final. Deve ser no formato "03/11/2021 10:37:28"
searchFor
String
É o equivalente a busca geral no sistema