Get Charge Items | Deel. PayAndBill API Documentation

curl -G https://{{baseurl}}/charge-item \
     -H "Authorization: Bearer <token>" \
     -d page=1 \
     -d limit=20 \
     -d sortColumn=name \
     -d searchColumn=name \
     -d searchValue=Standard \
     -d region=GB

{
  "rows": [
    {
      "uuid": "9cff2292-bb1d-489e-b701-137741f62ffd",
      "name": "Standard Charge",
      "description": "Standard hourly charge",
      "chargeItemType": 0,
      "chargeBasis": 0,
      "rateMultiplier": "1.0000",
      "additionalChargeAmount": "0.0000",
      "taxApplicableOnInvoices": "f68627eb-db98-40dc-91fb-e26525a28b1c",
      "taxApplicableOnInvoicesDescription": "VAT 20%",
      "region": "GB",
      "enabled": true,
      "isDefault": false,
      "isDefaultInvoiceChargeItem": false,
      "invoiceItemType": "125db94c-0019-4ffa-aede-041509353918"
    }
  ],
  "limit": 20,
  "totalCount": 94,
  "currentPage": 1,
  "totalPages": 5
}

Retrieve a paginated list of charge items for the tenant.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number to retrieve. Starts from 1.

limitintegerOptional

Maximum number of records to return per page.

sortColumnstringOptional

Field to sort results by.

sortOrderenumOptional

Sort direction.

Allowed values:

searchColumnstringOptional

Column to search on.

searchValuestringOptional

Value to search for in searchColumn.

regionstringOptional

Filter by region code (e.g. GB, AU, NZ).

enabledbooleanOptional

Filter by enabled status.

includestringOptional

Comma-separated list of field paths to include in each row (e.g. uuid,name).

Response

Successful Response

rowslist of objectsOptional

limitintegerOptional

totalCountintegerOptional

Total number of matching charge items.

currentPageintegerOptional

totalPagesintegerOptional

Authentication

Headers

Query parameters

Response