0

Get sales order

by
Published Oct 17, 2025

The *Get sales order* endpoint returns a single sales order for a given salesOrderId. [Sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) represent a customer's intention to purchase goods or services from the SMB. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).

Script codat Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Codat = {
3
	encodedKey: string
4
}
5
/**
6
 * Get sales order
7
 * The *Get sales order* endpoint returns a single sales order for a given salesOrderId.
8

9
[Sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) represent a customer's intention to purchase goods or services from the SMB.
10

11
Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).
12

13
 */
14
export async function main(auth: Codat, companyId: string, salesOrderId: string) {
15
	const url = new URL(
16
		`https://api.codat.io/companies/${companyId}/data/salesOrders/${salesOrderId}`
17
	)
18

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