Skip to main content
GET
Retrieve supplier

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Response

The supplier.

name
string
required
Maximum string length: 64
country
string
required

Country ID.

id
integer
read-only
tax_id
string | null
Maximum string length: 32
state
integer | null
currency
string
default:USD

ISO currency code.

address
string | null
Maximum string length: 64
email
string<email> | null
phone
string | null
Maximum string length: 16
website
string<uri> | null
tax_settings
object

Country-specific tax-agency configuration.

created
string<date-time>
read-only
updated
string<date-time>
read-only