Lançar um documento no fluxo de pagamentos

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.

POST https://webservices.vianuvem.com.br/AdminVianuvem/api/document/capture

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	Token de acesso adquirido através da API "Get JWT" (bearer)

Request Body

Name	Type	Description
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

200: OK Requisição de sucesso

{
    "documents": [
        {
            "documentId": 27923418,
            "createDate": "2021-11-03T13:27:33.907-03:00",
            "status": false,
            "currentVersion": 1,
            "documentTypeId": 700766,
            "accountId": 50182,
            "documentObjects": [
                {
                    "documentObjectId": 279234187,
                    "storageLocal": "d2f7c1a59169ec3dbdec6906da780246/5d15ea7da65c52521253202.original.pdf",
                    "objectSize": null,
                    "objectTypeId": 70033766,
                    "createDate": "2021-11-03T13:27:33.907-03:00",
                    "fullSignedPath": "https://cdn.vianuvem.com.br/d2f7c1a59153e5d/1b1aa6c0f50980c23d2a7c285d9aef68.original.pdf?Expires=1636316855&Signature=r19g4ux329mgv2uUIbea6je01RYSIG4ULH2FkbKH3R60WV0yuW~YU7d0B4PCbIWs51Y-d5TbGoFtQoja641xg5E613WLl7BKBsMZI3IrlZnsqduLu4wi~QchAwoKC9wZjTLMysMeLr5oZoQMkQs1x7wFyve-LfuCCUeJmxg2pbLomSlHMn7NUbf~eqUTimaQvh7sQjgWQ9pOvgTovFbYo7N0fBcQz1jxOwFf4PBovG7lB9Fx~bVuI5Pu4pUlwTlC99GthaAgMw43CjS-DqRKYP~ZWQALjEre3i2rQe5BYovZk3QGHnJfwM0AhkvOSw053lAf6x~g5gWAV~jjfJn6mg__&Key-Pair-Id=APKAJB5L4ASFURY6CXTA"
                }
            ],
            "workflowInstanceId": null
        }
    ],
    "transitionsTree": []
}

412: Precondition Failed Erro nos parâmetros enviados

500: Internal Server Error Erro de autenticação

Exemplo de requisição:

{ 
	"workflowId": 50029958,
	"establishmentCNPJ": 73386365000170,
	"documentVOList": 
	[ 
		{ 
			"documentTypeId": 70033766,
			"documentObjects": 
			[ 
				{ 
					"attachments": [],
					"indexers": 
					[
						{
							"sequence":1, 
							"indexerTypeName":"INTEIRO", 
							"indexerValue":"1234", 
							"indexerType":"I" 
						},
                        {
							"sequence":2, 
							"indexerTypeName":"TEXTO", 
							"indexerValue":"TESTE", 
							"indexerType":"S" 
						}
					],
					"name":"pdf.pdf",
					"objectSize":0,
					"observation":"Inserido via integração",
					"objectTypeId":2,
					"documentObjectAsBase64":
						"JVBERi0xLZjN1BO7q9Rgo..."
			}
		]
	}
]
}