Skip to main content
POST
Create a remittance account enrollment

Authorizations

Authorization
string
header
required

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

Body

application/json
remittance_account_id
string
required
work_assignment_id
string
required
effective_from
string<date>
required
effective_to
string<date>
overlap_strategy
enum<string>

When set to replace_existing, overlapping enrollments for the same work assignment and account provider are resolved automatically instead of returning a validation error. Existing enrollments that started before the new effective_from are ended (their effective_to is set to the day before), and overlapping enrollments that start on or after the new effective_from are deleted.

Available options:
replace_existing

Response

201 - application/json

Created

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Remittance Account Enrollment · object