Skip to content

Deel: Treasury schemas

7 Deel schemas with complete fields and constraints.

← Treasury operations · All schemas

Create Vendor Bill — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create Vendor Bill — 201 response body — data

Referenced models: Create Vendor Bill — 201 response body — data

Create Vendor Bill — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeTotal amount including VAT
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentCreation timestamp
Format: date-time
currencystringRequired within parentISO 4217 currency code
datestringRequired within parentInvoice/bill date
Format: date
descriptionstringRequired within parentGeneral description of the vendor bill
due_datestringRequired within parentDue date for payment
Format: date
exchange_rateJSONRequired within parent
exchange_rate (anyOf 1)JSONAlternative
exchange_rate (anyOf 1) (anyOf 1)numberAlternativeExchange rate to USD
Format: double
exchange_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exchange_rate (anyOf 2)nullAlternativeExchange rate to USD
Format: double
external_idstringRequired within parentExternal system identifier (e.g., Brightflag ID)
idstringRequired within parentUnique identifier for the vendor in the treasury system
Format: uuid
is_activebooleanRequired within parentWhether the vendor bill is active
line_itemsarrayRequired within parentLine items for the vendor bill
line_items[]ModelEach itemExpand Create Vendor Bill — 201 response body — data line items item
referencestringRequired within parentVendor bill reference
subsidiary_idstringRequired within parentUnique identifier for the Deel legal entity/subsidiary
subtotalJSONRequired within parent
subtotal (anyOf 1)numberAlternativeSubtotal amount excluding VAT
Format: double
subtotal (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentLast update timestamp
Format: date-time
vendor_idstringRequired within parentVendor ID

Referenced models: Create Vendor Bill — 201 response body — data line items item

Create Vendor Bill — 201 response body — data line items item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeTotal amount for this line item
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentCreation timestamp
Format: date-time
department_idJSONOptional
department_id (anyOf 1)stringAlternativeUnique identifier for the Financial department
department_id (anyOf 2)nullAlternativeUnique identifier for the Financial department
descriptionstringRequired within parentDescription of the line item
expense_account_idJSONOptional
expense_account_id (anyOf 1)stringAlternativeUnique identifier for the expense account
expense_account_id (anyOf 2)nullAlternativeUnique identifier for the expense account
idstringRequired within parentUnique identifier of the line item
Format: uuid
quantityJSONRequired within parent
quantity (anyOf 1)numberAlternativeQuantity of items
Format: double
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit_priceJSONRequired within parent
unit_price (anyOf 1)numberAlternativePrice per unit
Format: double
unit_price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentLast update timestamp
Format: date-time
vat_amountJSONRequired within parent
vat_amount (anyOf 1)numberAlternativeVAT amount for this line item
Format: double
vat_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vat_codeJSONOptional
vat_code (anyOf 1)stringAlternativeVAT code name
vat_code (anyOf 2)nullAlternativeVAT code name
vat_rateJSONRequired within parent
vat_rate (anyOf 1)numberAlternativeVAT rate percentage
Format: double
vat_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
vendor_bill_idstringRequired within parentReference to parent vendor bill
Format: uuid

Create Vendor Bill — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
amountnumberRequired within parentTotal amount including VAT
Format: double
currencystringRequired within parentISO 4217 currency code
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
datestringRequired within parentInvoice/bill date
Format: date
descriptionstringRequired within parentGeneral description of the vendor bill
Minimum length: 1
due_datestringRequired within parentDue date for payment
Format: date
external_idstringRequired within parentExternal system identifier (e.g., Brightflag ID)
Minimum length: 1
line_itemsarrayRequired within parentLine items for the vendor bill
line_items[]ModelEach itemExpand Create Vendor Bill — request body — body data line items item
referencestringRequired within parentVendor bill reference
Maximum length: 100
Minimum length: 1
subsidiary_idstringRequired within parentUnique identifier for the Deel legal entity/subsidiary
subtotalnumberRequired within parentSubtotal amount excluding VAT
Format: double
vendor_idstringRequired within parentUnique identifier for the Vendor

Referenced models: Create Vendor Bill — request body — body data line items item

Create Vendor Bill — request body — body data line items item

FieldTypePresenceDescription and constraints
$objectRoot
amountnumberRequired within parentTotal amount for this line item
Format: double
department_idstringOptionalUnique Identifier for the Financial department
descriptionstringRequired within parentDescription of the line item
Minimum length: 1
expense_account_idstringOptionalUnique Identifier for the Expense account
quantitynumberRequired within parentQuantity of items
Format: double
unit_pricenumberRequired within parentPrice per unit
Format: double
vat_amountnumberOptionalVAT amount for this line item
Format: double
vat_codestringOptionalVAT Code name
vat_ratenumberRequired within parentVAT rate percentage
Format: double
Minimum: 0

Upload Vendor Bill Attachment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Upload Vendor Bill Attachment — 201 response body — data

Referenced models: Upload Vendor Bill Attachment — 201 response body — data

Upload Vendor Bill Attachment — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation timestamp
Format: date-time
idstringRequired within parentUnique identifier of the uploaded attachment
Format: uuid
updated_atstringRequired within parentLast update timestamp
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.