NMnmbr
Accounting Code Rules

Create an accounting code rule

Changed on
post/accounting_code_rules

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Request body

business_entity_idstring required
tag_group_idstring

A tag group to scope this rule to. When set without tag_id, creates a tag-group-level rule that applies to all tags in the group.

tag_idstring

A tag from the business entity's accounting code tag group. Optional — when omitted, the rule matches line items by type/subtype or business_preset_id alone.

type'allowance' | 'deduction' | 'earning' | 'employee_benefit' | 'employer_benefit' | 'employer_statutory_withholding' | 'reimbursement' | 'statutory_withholding'

The line item type to scope this rule to (e.g. earning, deduction). Mutually exclusive with business_preset_id.

subtypestring nullable

This attribute is deprecated and will be removed.

Use subtypes. Still accepted, meaning a single-member set, and rejected against a rule that already holds several subtypes rather than truncating it. Sending both fields with values that disagree is rejected.

subtypesstring[]

The line item subtypes to further scope this rule to (e.g. wage, salary). A rule matches a line item whose subtype is any member of the set. Every subtype must belong to type, which a non-empty set requires. Supplying the set replaces it outright — there is no add-one or remove-one. No two rules in the same scope (same tag, same tag group, or both global) and on the same type may share a subtype.

business_preset_idstring

A business preset to scope this rule to. Provides the highest specificity match. Mutually exclusive with type and subtypes.

A rule with none of tag_id, tag_group_id, type, or business_preset_id is the catch-all: it matches any line item as the last resort when no other rule applies. At most one catch-all may exist per business entity.

expense_accounting_code_idstring
liability_accounting_code_idstring

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes

  • 3118dfecd5beRevision changes
    • info

      added the new optional request property /

    • info

      request property / deprecated

    • info

      added the optional property / to the response with the status

    • info

      response property data/subtype deprecated

  • 544a6469dc3fRevision changes
    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status