Get billing entity by code

GET

/v1/billing_entities/{code}

Get a billing entity by its code.

Parameters

Path Parameters

code

required

Code

string

Responses

200

Successful Response

BillingEntityResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

legal_name

required

Any of:

string

string

null

null

address_line1

required

Any of:

string

string

null

null

address_line2

required

Any of:

string

string

null

null

city

required

Any of:

string

string

null

null

state

required

Any of:

string

string

null

null

country

required

Any of:

string

string

null

null

zip_code

required

Any of:

string

string

null

null

tax_id

required

Any of:

string

string

null

null

email

required

Any of:

string

string

null

null

currency

required

Currency

string

timezone

required

Timezone

string

document_locale

required

Document Locale

string

invoice_prefix

required

Any of:

string

string

null

null

next_invoice_number

required

Next Invoice Number

integer

invoice_grace_period

required

Invoice Grace Period

integer

net_payment_term

required

Net Payment Term

integer

invoice_footer

required

Any of:

string

string

null

null

is_default

required

Is Default

boolean

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized – invalid or missing API key

404

Billing entity not found

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object