Additional codes

List, create, read, update and delete additional codes, the data sets used on purchase order lines.

Additional codes are the extra reference codes you can set on purchase order lines. You can list, create, read, update and delete them. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List additional codes	GET	/settings/additional_codes	Returns a page of additional codes under data, with paging details under pagination.
Create an additional code	POST	/settings/additional_codes	Creates an additional code and returns it under additional_code.
Retrieve an additional code	GET	/settings/additional_codes/{additional_code_id}	Returns one additional code by its id, under additional_code.
Delete an additional code	DELETE	/settings/additional_codes/{additional_code_id}	Deletes an additional code. The response has no body.
Update an additional code	PATCH	/settings/additional_codes/{additional_code_id}	Changes the fields or the status of an additional code.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Requests and responses wrap the record in additional_code. A create sends {"additional_code": {...}} and a read returns the record under the same key.
• name is the one required field on a create.
• An additional code id starts with ac_. Use that id in the path of a read, an update or a delete.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the additional code afterwards returns 404.