Reference data

List HS codes

GET /i/v1/invoices/hsn-codes

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`search`	query	string	No	Case-insensitive text in the code, description or category. At most 100 characters.
`category`	query	string	No	Exact category name (case-insensitive). At most 100 characters.
`page`	query	number	No	Default: `1`. At least 1.
`limit`	query	number	No	Default: `20`. Between 1 and 100.

Example request

bash

curl https://gp.useyona.com/i/v1/invoices/hsn-codes \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Errors: 400, 403, 422

GET /i/v1/invoices/hsn-codes/categories

Who can call it: API key or signed-in user.

Example request

bash

curl https://gp.useyona.com/i/v1/invoices/hsn-codes/categories \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

The HS code categories, sorted.

Errors: 403, 422

GET /i/v1/invoices/resources

Who can call it: API key or signed-in user.

Example request

bash

curl https://gp.useyona.com/i/v1/invoices/resources \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Errors: 403, 422

GET /i/v1/invoices/resources/{type}

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`type`	path	string	Yes

Example request

bash

curl https://gp.useyona.com/i/v1/invoices/resources/tax-categories \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Errors: 400, 403, 404, 422

GET /i/v1/invoices/lookup/tax-id/{value}

Who can call it: API key or signed-in user.

Parameters

Name	In	Type	Required	Description
`value`	path	string	Yes	At most 64 characters.
`type`	query	string	No	One of `tin` \| `rn` \| `foreign`. Default: `tin`.
`Idempotency-Key`	header	string	No	8–128 of [A-Za-z0-9_-].

Example request

bash

curl https://gp.useyona.com/i/v1/invoices/lookup/tax-id/33875194-0001 \
  -H "Authorization: Bearer sk_test_your_key_here"

Responses

Errors: 400, 402, 403, 409, 422, 503