0

Download direct income attachment

by
Published Oct 17, 2025

The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale.

Script codat Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Codat = {
3
	encodedKey: string
4
}
5
/**
6
 * Download direct income attachment
7
 * The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.
8

9
[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale.
10
 */
11
export async function main(
12
	auth: Codat,
13
	companyId: string,
14
	connectionId: string,
15
	directIncomeId: string,
16
	attachmentId: string
17
) {
18
	const url = new URL(
19
		`https://api.codat.io/companies/${companyId}/connections/${connectionId}/data/directIncomes/${directIncomeId}/attachments/${attachmentId}/download`
20
	)
21

22
	const response = await fetch(url, {
23
		method: 'GET',
24
		headers: {
25
			Authorization: `Basic ${auth.encodedKey}`
26
		},
27
		body: undefined
28
	})
29
	if (!response.ok) {
30
		const text = await response.text()
31
		throw new Error(`${response.status} ${text}`)
32
	}
33
	return await response.text()
34
}
35