Retrieve invoices | Deel

curl -G https://api.letsdeel.com/rest/invoices \
     -H "Authorization: Bearer <token>" \
     -d cursor=GqaY5BHQJUAM2Jg9kq2j2 \
     -d include=cor \
     -d issued_from_date=2022-05-24 \
     -d issued_to_date=2022-05-24 \
     -d limit=10 \
     -d offset=0 \
     -d status=all

{
  "data": [
    {
      "id": "GqaY5BHQJUAM2Jg9kq2j2",
      "label": "INV-2023-4",
      "total": "1000",
      "status": "paid",
      "vat_id": "123456789",
      "paid_at": "2022-05-24T09:38:46.235Z",
      "currency": "GBP",
      "due_date": "2022-05-24T09:38:46.235Z",
      "issued_at": "2022-05-24T09:38:46.235Z",
      "vat_total": "210",
      "created_at": "2022-05-24T09:38:46.235Z",
      "is_overdue": true,
      "contract_id": "37nex2x",
      "vat_percentage": "21",
      "amount": "1000",
      "deel_fee": "10",
      "recipient_legal_entity_id": "2c275e07-4846-490e-b2e4-6e84139032c3"
    }
  ],
  "page": {
    "offset": 0,
    "total_rows": 500,
    "items_per_page": 10,
    "cursor": "GqaY5BHQJUAM2Jg9kq2j2"
  }
}

Lists the invoices the caller can access, returning only paid and refunded invoices by default. Use GET /invoices/deel for Deel platform fee invoices, GET /billing/invoices for credit notes, and GET /invoices/{invoice_id} when you already hold an invoice id.

Token scopes: accounting:read

Authentication

AuthorizationBearer

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 -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

issued_from_datestringOptional

Filter invoices issued on or after the specified date.

issued_to_datestringOptional

Filter invoices issued before the specified date.

statusenumOptional

If status query has value of all, all invoices will be returned. Otherwise only paid invoices will be fetched.

Allowed values:

limitdoubleOptional1-50Defaults to 25

Number of records to retrieve per page.

offsetlongOptional0-999999999Defaults to 0

Index of the first record to return.

cursorstringOptional

Return next page of results after the given cursor.

includeenumOptional

Will include invoices from COR workers in the response.

Allowed values:

Response

Successful operation.

datalist of objects

pageobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error