Skip to content

Deel: Accounting schemas

33 Deel schemas with complete fields and constraints.

← Accounting operations · All schemas

Download invoice PDF — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Download invoice PDF — 200 response body — data

Referenced models: Download invoice PDF — 200 response body — data

Download invoice PDF — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
expires_atstringOptionalThe expiration date and time of the download URL, after which the URL will no longer be accessible.
Format: date-time
idstringOptionalUnique identifier of the invoice.
urlJSONRequired within parent
url (anyOf 1)stringAlternativeURL to the requested invoice for download. This URL may expire after a certain duration.
url (anyOf 2)nullAlternativeURL to the requested invoice for download. This URL may expire after a certain duration.

Get invoice by id — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get invoice by id — 200 response body — data
The invoice resource returned

Referenced models: Get invoice by id — 200 response body — data

Get invoice by id — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe invoice resource returned
contract_idJSONOptional
contract_id (anyOf 1)stringAlternativeUnique identifier of the related contract. For invoices linked directly to a contract this is that contract; for invoices covering service reports it is the contract of the linked service report with the lowest id (for invoices spanning several contracts only that one is returned). Null when the invoice has no related contract (e.g. organization-level fee invoices).
contract_id (anyOf 2)nullAlternativeUnique identifier of the related contract. For invoices linked directly to a contract this is that contract; for invoices covering service reports it is the contract of the linked service report with the lowest id (for invoices spanning several contracts only that one is returned). Null when the invoice has no related contract (e.g. organization-level fee invoices).
created_atstringOptionalTimestamp of when the invoice was created in the system
Format: date-time
currencystringOptionalCurrency code for the invoice total
due_datestringOptionalThe due date for the invoice payment
Format: date-time
idstringOptionalUnique identifier for the invoice
issued_atstringOptionalDate and time when the invoice was issued
Format: date-time
labelstringOptionalHuman-readable label or reference number for the invoice
line_itemsarrayOptionalThe individual line items associated with the invoice
line_items[]ModelEach itemExpand Get invoice by id — 200 response body — data line items item
paid_atstringOptionalDate and time when the invoice was paid
Format: date-time
recipient_legal_entity_idstringOptionalUnique identifier for the recipient legal entity
Format: uuid
statusstringOptionalCurrent payment status of the invoice.
Known values: open, pending, skipped, preprocessing, processing, credited, processed, paid, failed, cancelled, refunded, unpayable, awaiting_payment
totalstringOptionalTotal amount of the invoice
worker_idstringOptionalUnique identifier for the worker profile
Format: uuid

Referenced models: Get invoice by id — 200 response body — data line items item

Get invoice by id — 200 response body — data line items item

FieldTypePresenceDescription and constraints
$objectRoot
adjustment_idJSONOptional
adjustment_id (anyOf 1)stringAlternativeFor line items sourced from an EOR adjustment payout, the id of the originating adjustment — matches the id returned by the Retrieve adjustments API (GET /contracts/{contract_id}/adjustments). Null for non-adjustment line items (e.g. fees, deposits). Global Payroll adjustment correlation is not yet supported. Note: for legacy (pre-migration) EOR adjustments the Retrieve adjustments API may return a legacy id instead; those historical line items may not correlate.
adjustment_id (anyOf 2)nullAlternativeFor line items sourced from an EOR adjustment payout, the id of the originating adjustment — matches the id returned by the Retrieve adjustments API (GET /contracts/{contract_id}/adjustments). Null for non-adjustment line items (e.g. fees, deposits). Global Payroll adjustment correlation is not yet supported. Note: for legacy (pre-migration) EOR adjustments the Retrieve adjustments API may return a legacy id instead; those historical line items may not correlate.
descriptionstringOptionalMain description of the line item
fx_ratestringOptionalExchange rate used for this line item
idstringOptionalUnique identifier for the line item
price_per_unitJSONOptional
price_per_unit (anyOf 1)numberAlternativePrice charged per unit
Format: double
price_per_unit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pricing_fx_ratestringOptionalExchange rate used for pricing calculations on this line item
quantityJSONOptional
quantity (anyOf 1)integerAlternativeQuantity of units billed in this line item
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sub_descriptionstringOptionalOptional additional description or detail
tax_ratestringOptionalTax rate applied to this line item
tax_typeJSONOptional
tax_type (anyOf 1)stringAlternativeType of tax applied (if any); can be null
tax_type (anyOf 2)nullAlternativeType of tax applied (if any); can be null
totalstringOptionalTotal amount for this line item
typeModelOptionalExpand Get invoice by id — 200 response body — data line items item type
The type of this line item

Referenced models: Get invoice by id — 200 response body — data line items item type

Get invoice by id — 200 response body — data line items item type

FieldTypePresenceDescription and constraints
$stringRootThe type of this line item
Known values: AI_WORKFORCE_MONTHLY_FEE, ANON_REPORT_FEE, ANYTIME_PAY_GP_RESERVE, ASO_FEE, ASO_PAYROLL_FUNDING, ATS_LINKEDIN_PREMIUM_FEE, BACKGROUND_CHECK_FEE, BANK_ACCOUNT_OPENING_FEE, BANK_FILE_FEE, BENEFITS_ADMIN_MONTHLY_PLATFORM_FEE, CLIENT_PREFUNDING_AMOUNT, COR_LOCAL_COLLECTION_FEE, COR_START_DELAY, CUSTOM_DOMAIN_FEE, CUSTOM_ONE_OFF_COST, CUSTOM_ONE_OFF_FEE, DEEL_ATS_SUBSCRIPTIONS, DEEL_COMPENSATION_FEE, DEEL_ENGAGE_ATS_FEE, DEEL_ENGAGE_MONTHLY_SUBSCRIPTION_FEE, DEEL_FIELD_SERVICES_EOR_FEES, DEEL_FIELD_SERVICES_PASSTHROUGH_FEES, DEEL_FIELD_SERVICES_SWM_FEES, DEEL_HR_FEE, DEEL_HRIS_FEE, DEEL_IT_ACCESSORY_REPLACEMENT, DEEL_IT_APP_RESALE, DEEL_IT_ASSEMBLED_DELIVERY, DEEL_IT_BYOD_ACTIVATION_FEE, DEEL_IT_BYOD_STORAGE_FEE, DEEL_IT_CANCELLATION, DEEL_IT_CERTIFIED_DATA_ERASURE, DEEL_IT_CLEARANCE, DEEL_IT_CUSTOM_SHIPPING, DEEL_IT_CUSTOM_SOURCING, DEEL_IT_DEVICE_UNLOCK_FEE, DEEL_IT_ENDPOINT_PROTECTION_FEES, DEEL_IT_ENDPOINT_PROTECTION_FEES_OVERAGES, DEEL_IT_END_OF_CONTRACT_PURCHASE, DEEL_IT_EXPRESS_SHIPPING, DEEL_IT_EXTENDED_WARRANTY, DEEL_IT_IDENTITY_FEES, DEEL_IT_IDENTITY_FEES_OVERAGES, DEEL_IT_IT_SEAT, DEEL_IT_IT_SERVICE_DESK, DEEL_IT_JC_PLATFORM_FEES, DEEL_IT_JC_PLATFORM_FEES_OVERAGES, DEEL_IT_JC_PLATFORMPRIME_FEES, DEEL_IT_JC_PLATFORMPRIME_FEES_OVERAGES, DEEL_IT_LAPTOP_CONFIG, DEEL_IT_LOANER, DEEL_IT_MDM, DEEL_IT_MDM_OVERAGES, DEEL_IT_NON_DEEL_IT_DEVICE_CHARGE, DEEL_IT_PACKAGING, DEEL_IT_PURCHASE, DEEL_IT_REDISTRIBUTION_FEE, DEEL_IT_RENTAL, DEEL_IT_REPAIR, DEEL_IT_REPAIR_WITH_PARTS, DEEL_IT_REPLACEMENT, DEEL_IT_SAAS, DEEL_IT_SERVICE, DEEL_IT_SERVICE_BUNDLE, DEEL_IT_SHIPPING, DEEL_IT_SINGLE_ITEM_FEE, DEEL_IT_STOREFRONT_FEE, DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_FEE, DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_STORAGE_FEE, DEEL_IT_STORE_AND_REUSE_FEE, DEEL_IT_VAT, DEEL_IT_WELCOME_PACK, DEEL_MAINTENANCE_FEE, DEEL_TALENT_CLIENT_SAAS_FEE_ONE_OFF, DEEL_TALENT_CLIENT_SAAS_FEE_RECURRING, DEEL_TALENT_TP_SAAS_FEE_ONE_OFF, DEEL_TALENT_TP_SAAS_FEE_RECURRING, DEEL_WORKFORCE_PLANNING_SUBSCRIPTIONS, DEPOSIT_REFUND, DISCOUNT, DPA_AGREEMENT_FEE, EMPLOYEE_NAVIGATOR_IMPLEMENTATION_FEE, EMPLOYEE_NAVIGATOR_PEPM_FEE, ENGAGE_HR_SUITE_SUBSCRIPTION_FEE, ENGAGE_PLUGINS_SUBSCRIPTION_FEE, ENGAGE_ZAVVY_LEGACY_SUBSCRIPTION_FEE, ENTITY_MANAGEMENT_PLATFORM_FEE, ENTITY_SETUP_FEE, EOR_13_TH_14_TH_MONTH_SALARY, EOR_13_TH_MONTH_SALARY, EOR_ACCIDENT_AND_DISABILITY, EOR_ACCIDENT_AND_DISABILITY_FEE, EOR_ACCRUED_HOLIDAY, EOR_ADDITIONAL_FEE, EOR_ALLOWANCE, EOR_ANYTIME_PAYROLL_FEE, EOR_BENEFIT_IN_KIND_WITHHELD_AMOUNT, EOR_BONUS, EOR_COMPANY_DOCTOR_COST, EOR_DEDUCTION, EOR_DEPOSIT, EOR_EARLY_INVOICING_FUNDING_AMOUNT, EOR_EMPLOYER_COST, EOR_EQUITY_TAX_WITHHELD, EOR_EXPENSE, EOR_EXTERNAL_LEGAL_ADVISORY_COST, EOR_FERTILITY, EOR_FERTILITY_FEE, EOR_FERTILITY_PLAN_COST, EOR_FOREIGN_CURRENCY_CONTRACT_FEE, EOR_FOREIGN_CURRENCY_FEE, EOR_HEALTH_ALLOWANCE, EOR_HEALTH_ALLOWANCE_PLAN_COST, EOR_HEALTH_AND_SAFETY_TRAINING_COST, EOR_HEALTH_BENEFIT, EOR_HEALTH_BENEFIT_PLAN_COST, EOR_HEALTH_INSURANCE_FEE, EOR_LEGAL_FEE, EOR_LEGAL_SETTLEMENT_PAYOUT, EOR_LIFE_INSURANCE, EOR_LIFE_INSURANCE_FEE, EOR_LIFE_INSURANCE_PLAN_COST, EOR_LOCAL_COLLECTION_FEE, EOR_MANAGEMENT_FEE, EOR_MEAL_VOUCHER, EOR_MEAL_VOUCHER_FEE, EOR_MEAL_VOUCHER_PLAN_COST, EOR_MEDICAL_ONBOARDING_COST, EOR_MENTAL_HEALTH, EOR_MENTAL_HEALTH_FEE, EOR_MENTAL_HEALTH_PLAN_COST, EOR_NON_STATUTORY_EMPLOYER_COST, EOR_OFFCYCLE, EOR_OFF_BOARDING_FEE, EOR_OTHER, EOR_PENSION, EOR_PENSION_FEE, EOR_PENSION_PLAN_COST, EOR_QES_FEE, EOR_SALARY_ADVANCE, EOR_SETUP_FEE, EOR_SEVERANCE, EOR_SIGNING_BONUS, EOR_SIGNING_BONUS_DEDUCTION, EOR_SIGNING_BONUS_EMPLOYER_COST, EOR_SIGNING_BONUS_EMPLOYER_COST_DEDUCTION, EOR_SINGLE_TERMINATION_FEE, EOR_START_DELAY, EOR_STUDY_FUND, EOR_STUDY_FUND_FEE, EOR_STUDY_FUND_PLAN_COST, EOR_TAX_RULING, EOR_TAX_VAT, EOR_TIME_OFF, EOR_TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE, EOR_TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE, EOR_VISA_MANAGEMENT_FEE, EOR_WET_INK_FEE, EOR_WORK, EQUITY_ANNUAL_SUBSCRIPTION_FEE, EQUITY_EOR_PER_HEAD_FEE, EQUITY_IMPLEMENTATION_FEE, EQUITY_MAINTENANCE_FEE, EXPENSE_CARD, EXPENSE_CARD_FEE, G2N_BENEFITS, G2N_BENEFIT_IN_KIND, G2N_EMPLOYER_CONTRIBUTIONS, G2N_EOR_NET_PAY_WITHOUT_EXPENSES, G2N_GROSS_DEDUCTIONS, G2N_GROSS_TAXABLE, G2N_NET_ADDITIONS, G2N_NET_DEDUCTIONS, G2N_NET_PAY, G2N_ODP_OFFSET, G2N_ON_CALL_OVERTIME, G2N_OTHER_ADJUSTMENTS, G2N_PAY_RATE, G2N_SEVERANCE, G2N_TOTAL_EXPENSES, G2N_VACATION_PAYOUT, G2N_WAGE_ADDITIONS, G2N_WORKER_TAX_AND_CONTRIBUTIONS, GLOBAL_HR_CONSULTING_ANNUAL_SUBSCRIPTION_FEE, GLOBAL_HR_CONSULTING_EOR_MASS_TERMINATION_FEE, GLOBAL_HR_CONSULTING_MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE, GLOBAL_HR_CONSULTING_MONTHLY_SUBSCRIPTION_FEE, GLOBAL_HR_CONSULTING_PROJECT_FEE, GLOBAL_HR_DPO_AS_A_SERVICE_ANNUAL_SUBSCRIPTION_FEE, GLOBAL_HR_EU_UK_REPRESENTATIVE_SERVICE_ANNUAL_SUBSCRIPTION_FEE, GLOBAL_HR_PRIVACY_CONSULTING_SERVICES_ANNUAL_SUBSCRIPTION_FEE, GLOBAL_HR_PRIVACY_SERVICES_ANNUAL_SUBSCRIPTION_FEE, GL_CUSTOM_CONFIGURATION, GP_ADD_ON_FEE, GP_ADVANCE_PAYMENTS_FEE, GP_BANK_ACCOUNTS_OPENED, GP_CHINA_DECLARATIONS, GP_DEEL_LIABILITY, GP_DEPOSIT, GP_EARLY_TERMINATION_FEE, GP_ELECTRONIC_SAFE_PAYSLIPS, GP_EMPLOYEE_AGREEMENTS_EFE, GP_EMPLOYEE_FUNDING, GP_EXCEPTIONAL_MATTERS_HOURS_FEE, GP_EXPENSES_FEE, GP_GB_PENSION_FUND_MANAGEMENT, GP_GLOBAL_RERUN_OF_PAYROLL_REPORTS_FEE, GP_LEGAL_CONTROL_ASSISTANCE_HOURS_FEE, GP_MEAL_VOUCHERS, GP_MEDICAL_VISITS, GP_NEW_BRANCH_CREATION_ASSISTANCES, GP_NEW_REPORTS_AND_MODIFICATIONS_FEE, GP_NON_AUTOMATED_LODGEMENTS_FEE, GP_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE, GP_PARALLEL_RUN_FEE, GP_PAYROLL_CONNECT_FEE, GP_PAYROLL_CONNECT_SETUP_ENTITY_FEE_FLAT, GP_PAYROLL_EMPLOYEE_FEE, GP_PAYROLL_EMPLOYEE_SERVICE_FEE, GP_PAYROLL_ENTITY_SETUP_FEE, GP_PAYROLL_FEE, GP_PAYROLL_FEE_PER_COUNTRY, GP_PAYROLL_FUNDING_FEE, GP_PAYROLL_OFFBOARDING_FEE, GP_PAYROLL_ONBOARDING_FEE, GP_PAYROLL_SOFTWARE_FEE, GP_START_DELAY, GP_VAT_TAX, GP_WORK_VISAS, GP_YEARLY_CLOSING_FEE, HEALTH_INSURANCE_ANNUAL_SUBSCRIPTION_FEE, HEALTH_INSURANCE_FEE, HEALTH_INSURANCE_MONTHLY_SUBSCRIPTION_FEE, HOFY_EQUIPMENT_MONTHLY_SUBSCRIPTION_FEE, HOFY_EQUIPMENT_SEMIANNUAL_SUBSCRIPTION_FEE, HOFY_EQUIPMENT_SERVICE, HOFY_EQUIPMENT_TERMINATION_FEE, IC_BONUS, IC_COMMISSION, IC_DEDUCTION, IC_DEEL_PERCENTAGE_FEE, IC_DEEL_PREMIUM, IC_EXPENSE, IC_MILESTONE, IC_OFFCYCLE, IC_OTHER, IC_OVERTIME, IC_PRO_RATA, IC_SAAS_FLAT, IC_SAAS_MISSING_FEES, IC_SAAS_PER_CONTRACT, IC_START_DELAY, IC_TASK, IC_TAX_VAT, IC_TIME_OFF, IC_WITHHOLDING_TAX, IC_WORK, INTEGRATION_HRIS_FEE, INTERCOMPANY_MARKUP_SALARY_EXPENSES, INTERCOMPANY_OTHER_FINANCIAL_EXPENSES, INTERCOMPANY_OTHER_FINANCIAL_INCOME, INTERCOMPANY_PAYMENTS_LEASE_SERVICES, INTERCOMPANY_PAYMENTS_MARKET_PENETRATION, INTERCOMPANY_PAYMENT_EOR_GP_SERVICES, INTERCOMPANY_PAYMENT_EOR_SERVICES, INTERCOMPANY_PAYMENT_GP_SERVICES, INTERCOMPANY_PAYMENT_TECHNOLOGY_BASED_SERVICES, INTERCOMPANY_PROVISION_COGS_SERVICES, INTERCOMPANY_PROVISION_G_AND_A_SERVICES, INTERCOMPANY_PROVISION_PRE_POST_SALES_SERVICES, INTERCOMPANY_PROVISION_R_AND_D_SERVICES, INTERCOMPANY_SALARY_EXPENSES_PARTICIPATION, LATE_PAYMENT_FEE, LOCAL_TAX_REIMBURSEMENT_FEE, MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE, MOBILITY_BUSINESS_VISA_APPLICATION, MOBILITY_BUSINESS_VISA_DOCUMENT_PREPARATION, MOBILITY_BUSINESS_VISA_ISSUANCE, MOBILITY_BUSINESS_VISA_TRAVEL_LETTER, MOBILITY_DOCUMENTATION_FEE, MOBILITY_DOCUMENT_A_ONE_CERTIFICATE, MOBILITY_DOCUMENT_COLLECTION, MOBILITY_DOCUMENT_ISSUANCE, MOBILITY_DOCUMENT_MANAGEMENT, MOBILITY_DOCUMENT_PREPARATION, MOBILITY_DOCUMENT_REVIEW, MOBILITY_EXPENSE_GOVERNMENT_FEES, MOBILITY_EXPENSE_MAIL_TRANSPORTATION, MOBILITY_EXPENSE_OTHER, MOBILITY_EXPENSE_PRINTING, MOBILITY_EXPENSE_TRANSLATION, MOBILITY_GOVERNMENT_STATUTORY_LEGAL_FEE, MOBILITY_H1_B_LOTTERY, MOBILITY_IMMIGRATION_CONSULTATION, MOBILITY_IMMIGRATION_DEPENDANT, MOBILITY_IMMIGRATION_DEPENDANT_RENEWAL, MOBILITY_IMMIGRATION_EMPLOYER_TRANSFER, MOBILITY_IMMIGRATION_FAST_TRACK, MOBILITY_IMMIGRATION_PROCESSING_FEE, MOBILITY_IMMIGRATION_RENEWAL_EXTENSION, MOBILITY_IMMIGRATION_VISA_CANCELLATION, MOBILITY_IMMIGRATION_WORK_PERMIT, MOBILITY_NOTIFICATION_CHANGE_OF_EMPLOYER, MOBILITY_NOTIFICATION_GENERAL, MOBILITY_NOTIFICATION_PREFECTURE, MOBILITY_USCIS_PREMIUM_PROCESSING, NETX_FEE, OFFICE_SOLUTION_COST, OFFICE_SOLUTION_FEE, PAYGROUP_ASTUTE_CUSTOM_DEVELOPMENT_FEE, PAYGROUP_ASTUTE_FEE, PAYGROUP_ASTUTE_IMPLEMENTATION_FEE, PAYGROUP_ASTUTE_INTEGRATION_FEE, PAYGROUP_COR_CONTRACTOR_COST, PAYGROUP_COR_MANAGEMENT_FEE, PAYGROUP_EOR_DEPOSIT, PAYGROUP_EOR_EMPLOYEE_COST, PAYGROUP_EOR_MANAGEMENT_FEE, PAYGROUP_FLARE_REFERRAL_FEE, PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_OFFCYCLES, PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_ONBOARDING, PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_TERMINATIONS, PAYGROUP_GP_ANNUAL_LODGEMENT_PROCESSING_FEE, PAYGROUP_GP_ANNUAL_PAYMENT_SUMMARY_FEE, PAYGROUP_GP_EMPLOYEE_REPORT_FEE, PAYGROUP_GP_IMPLEMENTATION_FEE, PAYGROUP_GP_LODGEMENT_FEE, PAYGROUP_GP_TREASURY_FEE, PAYGROUP_HR_MANAGEMENT_FEE, PAYGROUP_HR_MANAGER_FEE, PAYGROUP_IWS_BAS_LODGEMENT_FEE, PAYGROUP_IWS_BOOKKEEPING_FEE, PAYGROUP_IWS_IMPLEMENTATION_FEE, PAYGROUP_IWS_ROSTERING_FEE, PAYGROUP_PAYROLL_PROCESSING_FEE, PAYGROUP_RECRUITMENT_FEE, PAYGROUP_SMS_FEE, PAYGROUP_TALENTOZ_ANNUAL_SUBSCRIPTION_FEE, PAYGROUP_TALENTOZ_IMPLEMENTATION_FEE, PAYGROUP_TAX_CGST, PAYGROUP_TAX_CONSUMPTION, PAYGROUP_TAX_GST, PAYGROUP_TAX_IGST, PAYGROUP_TAX_SGST, PAYGROUP_TAX_SST, PAYGROUP_TAX_VAT, PAYMENT_PROCESSING_FEE, PEO_CARROT_FERTILITY_JOURNEY_FEE, PEO_COBRA_CONTINUATION_FEE, PEO_EARLY_TERMINATION_FEE, PEO_EMPLOYEE_FUNDING, PEO_EXPENSES_FEE, PEO_FEE, PEO_LATE_PAYMENT_FEE, PEO_OFFCYCLE_FEE, PEO_NON_PEO_EE_MINERAL_ACCESS_FEE, PEO_PAYROLL_COST, PEO_POSTERS, PEO_RETIREMENT_PLAN_ADMIN_FEE, PEO_RETIREMENT_PLAN_ESTABLISHMENT_FEE, PEO_RETROACTIVE_FEE, PEO_TIMECO_FEE, PEO_WC_BILLING_ND, PEO_WC_BILLING_OH, PEO_WC_BILLING_WA, PEO_WC_BILLING_WY, PEO_DELIVERY_FEE, PEO_IMPLEMENTATION_FEE, POST_REGISTRATION_FEE, PREPAID_BILLING_CONTRACTOR, PREPAID_BILLING_EOR, PREPAID_BILLING_EXPIRED_CREDITS, PREPAID_BILLING_FUNDING_AMOUNT, PRE_REGISTRATION_FEE, REFUND, SAAS_PER_EQUIPMENT_FEE, SERVICE_REFUND, SHIELD_DEPOSIT, SHIELD_MANAGEMENT_FEE, SHIELD_PAYROLL_COSTS, SYSTEM_INTEGRATOR_FEE, TALENT_FEE, TAX_CUSTOM, TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE, TRAVEL_INSURANCE_FEE, TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE, UNSPECIFIED, US_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE, US_PAYROLL_CERTIFICATE_OF_GOOD_STANDING_FEE, US_PAYROLL_DUPLICATE_FILING_FEE, US_PAYROLL_EMPLOYEE_FEE, US_PAYROLL_EMPLOYEE_FUNDING, US_PAYROLL_EXPENSES_FEE, US_PAYROLL_FRANCHISE_REGISTRATION_SETUP_FEE, US_PAYROLL_FRANCHISE_REGISTRATION_STATE_FILING_FEE, US_PAYROLL_FUNDING_FEE, US_PAYROLL_MAILING_FEE, US_PAYROLL_OFFBOARDING_FEE, US_PAYROLL_ONBOARDING_FEE, US_PAYROLL_PAYROLL_REGISTRATION_SETUP_FEE, US_PAYROLL_PLATFORM_FEE, US_PAYROLL_REGISTERED_AGENT_ANNUAL_SUBSCRIPTION_FEE, VMS_TALENT_PARTNER_FEE, WEWORK_ACCESS_FEE, WITHHOLDING_TAX, EOR_HEALTH_AND_SAFETY_TRAINING_FEE

Retrieve Deel invoices — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve Deel invoices — 200 response body — data item
pageModelRequired within parentExpand Retrieve Deel invoices — 200 response body — page

Referenced models: Retrieve Deel invoices — 200 response body — data item, Retrieve Deel invoices — 200 response body — page

Retrieve Deel invoices — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
created_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
currencystringRequired within parentCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentUnique identifier of the invoice.
labelstringRequired within parentLabel of the invoice.
statusstringRequired within parentCurrent status of the invoice.
Known values: pending, paid, processing, canceled, skipped, failed, refunded
totalstringRequired within parentTotal invoice amount including Fee and VAT.

Retrieve Deel invoices — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of items per page
Format: double
Maximum: 99
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeOffset
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a payment breakdown — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve a payment breakdown — 200 response body — data item

Referenced models: Retrieve a payment breakdown — 200 response body — data item

Retrieve a payment breakdown — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
adjustmentstringOptionalAdjustment amount for the payment.
approve_dateModelOptionalExpand Retrieve a payment breakdown — 200 response body — data item approve date
Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments.
approversstringOptionalComma-separated list of names of people who approved this payment. May be empty if no approvals were required or recorded.
bonusstringOptionalAdditional bonus payment amount awarded to the worker.
commissionsstringOptionalCommissions included in the payment.
contract_countrystringOptionalCountry where the contract is established.
contract_idJSONOptional
contract_id (anyOf 1)stringAlternativePublic identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items.
contract_id (anyOf 2)nullAlternativePublic identifier of the contract this line item belongs to. Null for service-fee and similar non-contract line items.
contract_start_dateModelOptionalExpand Retrieve a payment breakdown — 200 response body — data item contract start date
Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates.
contract_typeJSONOptionalType of contract this payment relates to. Determines the nature of the work relationship and payment structure.
contract_type (anyOf 1)ModelAlternativeExpand Retrieve a payment breakdown — 200 response body — data item contract type string
contract_type (anyOf 2)nullAlternative
contractor_emailstringOptionalEmail address of the worker.
contractor_employee_namestringOptionalName of the worker.
contractor_pic_urlJSONOptional
contractor_pic_url (anyOf 1)stringAlternativeURL to the worker's Deel avatar. Null if the worker has no avatar set or for non-worker line items.
contractor_pic_url (anyOf 2)nullAlternativeURL to the worker's Deel avatar. Null if the worker has no avatar set or for non-worker line items.
contractor_unique_identifierModelOptionalExpand Retrieve a payment breakdown — 200 response body — data item contractor unique identifier
Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees.
currencystringOptionalCurrency code for this payment.
datestringOptionalDate associated with the payment breakdown.
Format: date-time
deductionsstringOptionalDeductions from the payment.
expensesstringOptionalExpenses related to the payment.
frequencyModelOptionalExpand Retrieve a payment breakdown — 200 response body — data item frequency
Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements.
general_ledger_accountstringOptionalGeneral ledger account code or name for accounting purposes. May be configured at the group, company, or organization level. Empty if not configured.
group_idModelOptionalExpand Retrieve a payment breakdown — 200 response body — data item group id
Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group.
invoice_idstringOptionalUnique identifier of this resource.
othersstringOptionalOther payment amounts.
overtimestringOptionalOvertime payment amount.
payment_currencystringOptionalCurrency in which the payment was processed.
payment_datestringOptionalDate when the payment was made.
Format: date-time
pro_ratastringOptionalPro-rated payment amount.
processing_feestringOptionalProcessing fee amount applied to the payment.
totalstringOptionalTotal payment due for this breakdown item.
total_payment_currencystringOptionalTotal payment in the payment currency.
workstringOptionalBase payment amount for work performed, including regular salary/wages and off-cycle payments.

Referenced models: Retrieve a payment breakdown — 200 response body — data item approve date, Retrieve a payment breakdown — 200 response body — data item contract start date, Retrieve a payment breakdown — 200 response body — data item contract type string, Retrieve a payment breakdown — 200 response body — data item contractor unique identifier, Retrieve a payment breakdown — 200 response body — data item frequency, Retrieve a payment breakdown — 200 response body — data item group id

Retrieve a payment breakdown — 200 response body — data item approve date

FieldTypePresenceDescription and constraints
$JSONRootDate when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

Retrieve a payment breakdown — 200 response body — data item contract start date

FieldTypePresenceDescription and constraints
$JSONRootStart date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

Retrieve a payment breakdown — 200 response body — data item contract type string

FieldTypePresenceDescription and constraints
$stringRootType of contract this payment relates to. Determines the nature of the work relationship and payment structure.
Known values: milestones, time_based, ongoing_time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, peo, peo_csa, unknown, employee, global_payroll, shield_msa, gp_client_agreement, ep_client_agreement, power_of_attorney, debt_authorization, hris_direct_employee, hris_service_agreement, hofy_standalone_payment, wework_standalone_payment, travel_insurance_standalone_payment, health_insurance_standalone_payment, prepaid_billing, missing_saas_fees, one_off_service_fee, eor_management_fee, eor_one_off_management_fee, engage_monthly_subscription_fee, ats_subscription_fee, benefits_admin_monthly_platform_fee, contractor_outside_deel, late_payment_fee, background_check_standalone_payment, peo_service_fee, payment_processing_fee, deel_percentage_fee, netx_fee, prepaid_funding_statement, one_off_mobility_service_fee, prepaid_billing_expired_credits, implementation_delay, managed_hr_monthly_subscription_fee, expense_card, anon_report_fee, ic_maintenance_platform_fee, deel_it_order_statement, hris_direct_contractor, office_solutions, usp_service_fee, ic_contract_fees, mobility_subscription_service_fee, intercompany, deel_card_fee, entity_management, crypto_payout, deel_ai_workforce, deel_talent_fee, deel_hris, deel_compensation, contractor_subscription_fee, integration_services_fee, bundle_commitment_fee, wallet_chargeback_recovery_funding_statement, deel_workforce_planning_fee, fee_merge, payroll_merge, "" (empty string)

Retrieve a payment breakdown — 200 response body — data item contractor unique identifier

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier for the worker. May be empty for certain contract types such as service agreements and fees.
$ (anyOf 1)stringAlternativeFormat: uuid
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

Retrieve a payment breakdown — 200 response body — data item frequency

FieldTypePresenceDescription and constraints
$stringRootWork unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements.
Known values: hourly, daily, weekly, biweekly, semimonthly, monthly, custom, "" (empty string)

Retrieve a payment breakdown — 200 response body — data item group id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group.
$ (anyOf 1)stringAlternativeFormat: uuid
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

Retrieve invoices — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve invoices — 200 response body — data item
pageModelRequired within parentExpand Retrieve invoices — 200 response body — page

Referenced models: Retrieve invoices — 200 response body — data item, Retrieve invoices — 200 response body — page

Retrieve invoices — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)stringAlternativeBilled amount of the invoice.
amount (anyOf 2)nullAlternativeBilled amount of the invoice.
contract_idJSONRequired within parent
contract_id (anyOf 1)stringAlternativeUnique identifier of the related contract.
contract_id (anyOf 2)nullAlternativeUnique identifier of the related contract.
created_atstringRequired within parentDate and time when the invoice was created (ISO-8601 format).
Format: date-time
currencystringRequired within parentThree-letter currency code for the invoice.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
deel_feeJSONOptional
deel_fee (anyOf 1)stringAlternativeFee charged by Deel.
deel_fee (anyOf 2)nullAlternativeFee charged by Deel.
due_dateJSONRequired within parent
due_date (anyOf 1)stringAlternativeDate and time when the invoice is due (ISO-8601 format).
Format: date-time
due_date (anyOf 2)nullAlternativeDate and time when the invoice is due (ISO-8601 format).
Format: date-time
idstringRequired within parentUnique identifier of this resource.
is_overdueJSONRequired within parent
is_overdue (anyOf 1)booleanAlternativeIndicates whether the invoice is overdue.
is_overdue (anyOf 2)nullAlternativeIndicates whether the invoice is overdue.
issued_atJSONRequired within parent
issued_at (anyOf 1)stringAlternativeDate and time when the invoice was issued (ISO-8601 format).
Format: date-time
issued_at (anyOf 2)nullAlternativeDate and time when the invoice was issued (ISO-8601 format).
Format: date-time
labelstringRequired within parentLabel or reference number of the invoice.
paid_atModelRequired within parentExpand Retrieve invoices — 200 response body — data item paid at
Date/time when the invoice was paid (ISO-8601). May be null or empty string.
recipient_legal_entity_idstringOptionalUnique identifier for the recipient legal entity
Format: uuid
statusstringRequired within parentCurrent status of the invoice.
Known values: pending, paid, processing, credited, refunded
totalstringRequired within parentTotal invoice amount, including fees and VAT.
vat_idJSONRequired within parent
vat_id (anyOf 1)stringAlternativeVAT identification number related to the invoice.
vat_id (anyOf 2)nullAlternativeVAT identification number related to the invoice.
vat_percentageJSONRequired within parent
vat_percentage (anyOf 1)stringAlternativePercentage of VAT charged on the invoice.
vat_percentage (anyOf 2)nullAlternativePercentage of VAT charged on the invoice.
vat_totalJSONRequired within parent
vat_total (anyOf 1)stringAlternativeTotal amount of VAT charged on the invoice.
vat_total (anyOf 2)nullAlternativeTotal amount of VAT charged on the invoice.

Referenced models: Retrieve invoices — 200 response body — data item paid at

Retrieve invoices — 200 response body — data item paid at

FieldTypePresenceDescription and constraints
$JSONRootDate/time when the invoice was paid (ISO-8601). May be null or empty string.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternative

Retrieve invoices — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor for paginated results.
cursor (anyOf 2)nullAlternativeCursor for paginated results.
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of items displayed per page.
Format: double
Maximum: 99
Minimum: 1
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeThe starting position of the current page of results.
Format: double
Maximum: 999999999
Minimum: 0
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows available for the query.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data

Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanOptionalInform if there are more entries to be fetched using next cursor.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.
next_cursor (anyOf 2)nullAlternativeA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.
rowsarrayOptionalArray of payment receipts matching the query criteria.
rows[]ModelEach itemExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item
totalJSONOptional
total (anyOf 1)numberAlternativeThe total number of payments matching the query.
Format: double
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_countJSONOptional
total_count (anyOf 1)numberAlternativeThe total number of payments matching the query.
Format: double
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalDate and time when the payment was created, in ISO-8601 format.
Format: date-time
deel_granted_credits_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used
Amount paid using Deel-granted credits.
deel_referenceJSONOptional
deel_reference (anyOf 1)stringAlternativeDeel reference identifier for the payment.
deel_reference (anyOf 2)nullAlternativeDeel reference identifier for the payment.
eor_early_invoicing_funds_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used
Amount paid using EOR early invoicing funds.
general_funds_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used
Amount paid using the client's general balance funds.
idstringOptionalUnique identifier of the payment.
labelstringOptionalA descriptive label for the payment.
paid_atstringOptionalDate and time when the payment was completed, in ISO-8601 format.
Format: date-time
payment_currencystringOptionalThree or four-letter currency code for the payment, following ISO 4217 (e.g., USD, USDC).
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$
payment_methodModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method
Payment method details for the transaction.
prepaid_billing_credits_usedModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used
Amount paid using prepaid billing credits.
statusstringOptionalStatus of the payment. Either 'paid' or 'processing'.
Known values: paid, processing
timezonestringOptionalTimezone offset in ISO 8601 format (e.g., +02:00, -05:00).
Pattern: ^[+-]\d{2}:\d{2}$
totalstringOptionalOriginal invoice total before any credits or balance were applied.
total_duestringOptionalAmount due for the payment after applying any credits or balance. Equals 'total' when no credits were used.

Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method, Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item deel granted credits used

FieldTypePresenceDescription and constraints
$objectRootAmount paid using Deel-granted credits.
amountstringOptionalAmount deducted from Deel-granted credits, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from Deel-granted credits, in the original currency they were held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from Deel-granted credits, in the original currency they were held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency in which the Deel-granted credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$
original_currency (anyOf 2)nullAlternativeCurrency in which the Deel-granted credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item eor early invoicing funds used

FieldTypePresenceDescription and constraints
$objectRootAmount paid using EOR early invoicing funds.
amountstringOptionalAmount deducted from EOR early invoicing funds, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency in which the EOR early invoicing funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$
original_currency (anyOf 2)nullAlternativeCurrency in which the EOR early invoicing funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item general funds used

FieldTypePresenceDescription and constraints
$objectRootAmount paid using the client's general balance funds.
amountstringOptionalAmount deducted from general funds, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from general funds, in the original currency it was held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from general funds, in the original currency it was held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency in which the general funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$
original_currency (anyOf 2)nullAlternativeCurrency in which the general funds were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method

FieldTypePresenceDescription and constraints
$objectRootPayment method details for the transaction.
typeModelOptionalExpand Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method type
Type of payment method used for the transaction.

Referenced models: Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method type

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item payment method type

FieldTypePresenceDescription and constraints
$stringRootType of payment method used for the transaction.
Known values: stripe_bacs_debit, pay_pal, stripe_card, bt_card, stripe_ach, coinbase, go_cardless, brex, stripe_sepa_debit, transferwise, go_cardless_becs, bank_transfer, mercury_wire, bt_pay_pal, ach, client_balance, fee_credits, dbc_credits, eor_funding_balance, alviere_ach, adyen_card, stablecoin_transfer, sepa_debit, bacs_debit, wallet_balance

Retrieve payment receipts — accounting retrieve Payment Receipts — 200 response body — data rows item prepaid billing credits used

FieldTypePresenceDescription and constraints
$objectRootAmount paid using prepaid billing credits.
amountstringOptionalAmount deducted from prepaid billing credits, in the payment currency. '0.00' if not used.
original_amountJSONOptional
original_amount (anyOf 1)stringAlternativeAmount deducted from prepaid billing credits, in the original currency they were held in. Null if not used.
original_amount (anyOf 2)nullAlternativeAmount deducted from prepaid billing credits, in the original currency they were held in. Null if not used.
original_currencyJSONOptional
original_currency (anyOf 1)stringAlternativeCurrency in which the prepaid billing credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$
original_currency (anyOf 2)nullAlternativeCurrency in which the prepaid billing credits were held, following ISO 4217 (e.g., USD, USDC). Null if not used.
Maximum length: 4
Minimum length: 3
Pattern: ^[A-Z]{3,4}$

Retrieve refund statements — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve refund statements — 200 response body — data

Referenced models: Retrieve refund statements — 200 response body — data

Retrieve refund statements — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parentInform if there are more entries to be fetched using next cursor,.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.
next_cursor (anyOf 2)nullAlternativeA cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null.
rowsarrayRequired within parentArray of refund statements matching the query criteria.
rows[]ModelEach itemExpand Retrieve refund statements — 200 response body — data rows item
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeThe total number of refund statements matching the query.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve refund statements — 200 response body — data rows item

Retrieve refund statements — 200 response body — data rows item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount of the payment.
created_atstringRequired within parentDate and time when the refund statement was created, in ISO-8601 format.
Format: date-time
currencystringRequired within parentThree-letter currency code for the payment, following ISO 4217.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
idstringRequired within parentUnique identifier of the refund statement.
labelstringRequired within parentA descriptive label for the refund statement.
paid_atJSONOptional
paid_at (anyOf 1)stringAlternativeDate and time when the refund statement was completed, in ISO-8601 format.
Format: date-time
paid_at (anyOf 2)nullAlternativeDate and time when the refund statement was completed, in ISO-8601 format.
Format: date-time
payment_methodstringRequired within parentMethod of payment used for the refund statement.
Known values: bank_transfer, client_balance
statusstringRequired within parentStatus of the refund statement. Either 'paid', 'processing', 'cancelled' or 'failed'.
Known values: paid, processing, cancelled, failed

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.