Skip to main content
GET
/
remittance_account_enrollments
List remittance account enrollments
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/remittance_account_enrollments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [],
  "links": {
    "first": "/remittance_account_enrollments?remittance_account_id=<id>&page=1",
    "last": "/remittance_account_enrollments?remittance_account_id=<id>&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 0,
    "has_more": false
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
remittance_account_id
string
​
work_assignment_id
string
​
effective_on
string<date>
​
not_effective_on
string<date>
​
effective_from
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_from=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31
​
effective_to
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: effective_to=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31
​
expand
enum<string>[]
Available options:
remittance_account,
work_assignment

Response

200 - application/json

OK

​
object
string
read-only

The type of the object in Nmbr ("list").

​
data
object[]