# Get invoice by id GET https://api.letsdeel.com/rest/v2/invoices/{invoice_id} Retrieve invoice details **Token scopes**: `accounting:read` Reference: https://developer.deel.com/api/reference/endpoints/accounting/get-invoice-by-id ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Deel HRIS SCIM API version: 1.0.0 paths: /invoices/{invoice_id}: get: operationId: get-invoice-by-id summary: Get invoice by id description: |- Retrieve invoice details **Token scopes**: `accounting:read` tags: - subpackage_accounting parameters: - name: invoice_id in: path description: The invoice ID used to identify the invoice to be retireved. required: true schema: type: string - name: Authorization in: header description: > ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) required: true schema: type: string responses: '200': description: The invoice resource returned content: application/json: schema: $ref: '#/components/schemas/Accounting_getInvoiceById_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Invoice not found content: application/json: schema: $ref: '#/components/schemas/GetInvoiceByIdRequestNotFoundError' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' servers: - url: https://api.letsdeel.com/rest/v2 - url: https://api-staging.letsdeel.com/rest/v2 components: schemas: InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus: type: string enum: - open - pending - skipped - preprocessing - processing - credited - processed - paid - failed - cancelled - refunded - unpayable - awaiting_payment description: Current payment status of the invoice. title: InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType: type: string enum: - 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 description: The type of this line item title: >- InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems: type: object properties: id: type: string description: Unique identifier for the line item type: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType description: The type of this line item total: type: string description: Total amount for this line item quantity: type: integer description: Quantity of units billed in this line item tax_rate: type: string description: Tax rate applied to this line item tax_type: type: - string - 'null' description: Type of tax applied (if any); can be null description: type: string description: Main description of the line item price_per_unit: type: number format: double description: Price charged per unit sub_description: type: string description: Optional additional description or detail title: >- InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string description: Unique identifier for the invoice label: type: string description: Human-readable label or reference number for the invoice total: type: string description: Total amount of the invoice status: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus description: Current payment status of the invoice. paid_at: type: string format: date-time description: Date and time when the invoice was paid currency: type: string description: Currency code for the invoice total due_date: type: string format: date-time description: The due date for the invoice payment issued_at: type: string format: date-time description: Date and time when the invoice was issued worker_id: type: string format: uuid description: Unique identifier for the worker profile created_at: type: string format: date-time description: Timestamp of when the invoice was created in the system line_items: type: array items: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems description: The individual line items associated with the invoice recipient_legal_entity_id: type: string format: uuid description: Unique identifier for the recipient legal entity description: The invoice resource returned title: InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData Accounting_getInvoiceById_Response_200: type: object properties: data: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData description: The invoice resource returned title: Accounting_getInvoiceById_Response_200 ApiErrorRequest: type: object properties: method: type: string description: The HTTP method of the failed request url: type: string description: The relative URL of the failed request status: type: number format: double description: The status code of the response api_req_id: type: string description: The request ID of the failed request docs: type: string description: >- A link to the official documentation for the requested endpoint resource source: type: string description: The source handler which produced the returned error code: type: number format: double description: The code of the source handler which produced the returned error title: ApiErrorRequest ApiError: type: object properties: message: type: string description: A description of the returned error path: type: string description: The JSON path where input validation failed title: ApiError ApiErrorContainer: type: object properties: request: $ref: '#/components/schemas/ApiErrorRequest' errors: type: array items: $ref: '#/components/schemas/ApiError' title: ApiErrorContainer InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: message: type: string description: Error response required: - message title: InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest: type: object properties: method: type: string description: Method of the API status: type: number format: double description: Status of API response description: Error request details title: InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest GetInvoiceByIdRequestNotFoundError: type: object properties: errors: type: array items: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems description: Error messages request: $ref: >- #/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest description: Error request details required: - errors title: GetInvoiceByIdRequestNotFoundError securitySchemes: deelToken: type: http scheme: bearer description: > ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) oauth2: type: http scheme: bearer description: >- Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ``` ## SDK Code Examples ```python import requests url = "https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/v2/invoices/abcd1234efgh5678")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```