> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an ROE SAT agreement



## OpenAPI

````yaml /spec/openapi.json post /roe_sat_agreements
openapi: 3.0.0
info:
  title: Nmbr API
  description: API to interact with Nmbr Payroll
  version: 1.0.0
servers:
  - url: https://sandbox.nmbr.co/services/payroll
security:
  - CompanyToken: []
tags:
  - name: Accounting Codes
  - name: Accounting Code Rules
  - name: Adjustments
  - name: Allowances
  - name: Allowance Line Items
  - name: Allowance Types
  - name: Async Tasks
  - name: Bank Accounts
  - name: Business Entities
  - name: Business Entity Verifications
  - name: Business Entity ROE Authorizations
  - name: Business Presets
  - name: Calculations
  - name: Companies
  - name: Contractors
  - name: Deductions
  - name: Deduction Line Items
  - name: Deduction Types
  - name: Earnings
  - name: Earning Line Items
  - name: Earning Types
  - name: Effective Tax Properties
  - name: Employees
  - name: Employee Benefits
  - name: Employee Benefit Line Items
  - name: Employee Benefit Types
  - name: Employer Benefits
  - name: Employer Benefit Line Items
  - name: Employer Benefit Types
  - name: Employer Statutory Withholding Line Items
  - name: Employer Statutory Withholding Types
  - name: Forms
  - name: Form Batches
  - name: Form Types
  - name: Holidays
  - name: Integrations
  - name: Journal Entries
  - name: Overtime Rates
  - name: Partners
  - name: Pay Rates
  - name: Pay Schedules
  - name: Pay Splits
  - name: Pay Stubs
  - name: Payments
  - name: Payrolls
  - name: Reimbursements
  - name: Reimbursement Line Items
  - name: Reimbursement Types
  - name: Remittance Accounts
  - name: Remittance Account Enrollments
  - name: Remittance Totals
  - name: Reports
  - name: ROE SAT Agreements
  - name: Statutory Withholding Line Items
  - name: Statutory Withholding Types
  - name: Tags
  - name: Tag Groups
  - name: Tax Properties
  - name: Tax Property Templates
  - name: Tokens
  - name: Usage Records
  - name: Usage Summaries
  - name: Vacation Pay
  - name: Vacation Pay Settings
  - name: Webhooks
  - name: Work Assignments
paths:
  /roe_sat_agreements:
    post:
      tags:
        - ROE SAT Agreements
      summary: Create an ROE SAT agreement
      operationId: roe-sat-agreements-store
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    business_entity_id:
                      type: string
                      description: The Business Entity the agreement is recorded under.
                    business_number:
                      type: string
                      description: >-
                        The CRA payroll account number (BN15, e.g.
                        123456782RP0001) the agreement covers. Only one
                        non-revoked agreement may cover a business number at a
                        time.
                    business_legal_name:
                      type: string
                      description: >-
                        The client's legal name as written on the letter.
                        Defaults to the Business Entity's legal name when
                        omitted.
                      nullable: true
                      maxLength: 255
                    signer_name:
                      type: string
                      description: The person who signed the letter on the client's behalf.
                      maxLength: 255
                    signer_title:
                      type: string
                      description: The signer's job title.
                      maxLength: 255
                    signed_on:
                      type: string
                      description: The date written on the signed letter.
                      format: date
                    locale:
                      type: string
                      description: >-
                        The language of the letter (en or fr). Defaults to the
                        Business Entity's language when omitted.
                      enum:
                        - en
                        - fr
                    letter:
                      type: string
                      description: >-
                        The client's signed copy of the letter as a PDF. When
                        omitted, a copy of the letter recording the acceptance
                        is generated and attached automatically.
                      maxLength: 10240
                - type: object
                  required:
                    - business_entity_id
                    - business_number
                    - signer_name
                    - signer_title
                    - signed_on
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier of the object in Nmbr.
                    readOnly: true
                  object:
                    type: string
                    description: The type of the object in Nmbr (`"roe_sat_agreement"`).
                    readOnly: true
                  data:
                    $ref: '#/components/schemas/RoeSatAgreement'
              example:
                id: <id>
                object: roe_sat_agreement
                data:
                  business_entity:
                    id: <id>
                    object: business_entity
                    links:
                      self: /business_entities/<id>
                  business_number: 123456782RP0001
                  business_legal_name: Bobs Burgers (#39616)
                  signer_name: Bob Belcher
                  signer_title: Owner
                  signed_on: '2026-01-01'
                  revoked_at: null
                  locale: en
                  letter_was_uploaded: false
                  created_at: '2026-01-01T00:00:00.000000Z'
                  updated_at: '2026-01-01T00:00:00.000000Z'
                links:
                  self: /roe_sat_agreements/<id>
components:
  schemas:
    RoeSatAgreement:
      type: object
      title: Roe Sat Agreement
      properties:
        business_entity:
          type: object
          properties:
            id:
              type: string
              description: The unique identifier of the object in Nmbr.
              readOnly: true
            object:
              type: string
              description: The type of the object in Nmbr (`"business_entity"`).
              readOnly: true
        business_number:
          type: string
          description: >-
            The CRA payroll account number (BN15) the agreement covers. ROEs
            issued under this number are filed with Service Canada automatically
            while the agreement is not revoked.
          maxLength: 15
        business_legal_name:
          type: string
          description: The client's legal name as written on the letter.
          maxLength: 255
        signer_name:
          type: string
          description: The person who signed the letter on the client's behalf.
          maxLength: 255
        signer_title:
          type: string
          description: The signer's job title.
          maxLength: 255
        signed_on:
          type: string
          description: The date written on the signed letter.
          format: date
        revoked_at:
          type: string
          description: >-
            When the agreement was revoked. Null while the agreement is in
            effect.
          readOnly: true
          nullable: true
          format: dateTime
        locale:
          type: string
          description: The language of the letter (en or fr).
          maxLength: 2
          enum:
            - en
            - fr
        letter_was_uploaded:
          type: boolean
          description: >-
            Whether the attached letter is the client's uploaded signed copy
            (true) or a copy generated from the recorded details (false).
            Download it from `/roe_sat_agreements/{id}/letter`.
        created_at:
          type: string
          description: The date and time the object was created in Nmbr.
          readOnly: true
          format: dateTime
        updated_at:
          type: string
          description: The date and time the object was last updated in Nmbr.
          readOnly: true
          format: dateTime
  securitySchemes:
    CompanyToken:
      type: http
      scheme: bearer

````