Skip to main content
POST
Create a Supplier

Headers

Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Body

application/json

Supplier to create.

A supplier.

name
string
state
enum<string>
Available options:
Active,
Archived
territory
Reference to a territory · object

Read-only. Territory of the supplier.

territoryId
string
write-only

Write-only. ID of the territory.

contacts
object[]
paymentTerm
object | null

Default payment term for this supplier.

bankAccount
object | null
preferredNatureId
integer<int32> | null
write-only

Write-only. ID of the preferred nature.

preferredPaymentMethod
enum<string> | null

BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.

Available options:
BankTransfer,
PhysicalCard,
Check,
DirectDebit,
SingleUseCard
preferredCostCenterId
integer<int32> | null
write-only

Write-only. ID of the preferred cost-center.

Response

201 - application/json

Created

A supplier.

id
integer<int32>
read-only
name
string
state
enum<string>
Available options:
Active,
Archived
territory
Reference to a territory · object

Read-only. Territory of the supplier.

contacts
object[]
paymentTerm
object | null

Default payment term for this supplier.

bankAccount
object | null
preferredNature
object | null
read-only

Read-only. Preferred nature for this supplier.

preferredPaymentMethod
enum<string> | null

BankTransfer: bank transfer. PhysicalCard: physical card. Check: check. DirectDebit: direct debit. SingleUseCard: single use card.

Available options:
BankTransfer,
PhysicalCard,
Check,
DirectDebit,
SingleUseCard
preferredCostCenter
Reference to a cost-center · object

Read-only. Preferred cost-center for this supplier.

establishments
Reference to an establishment · object[]
read-only

Read-only. Establishments associated with this supplier.

flag
enum<string>
read-only
Available options:
Unflagged,
Flagged