younifyd
Menu

Get Contact CIS Settings

Retrieves CIS settings for a specific contact in a Xero organisation

GET/Contacts/{ContactID}/CISSettings

Use it in a workflow

  1. Add a step and choose the Xero connector.
  2. Pick the Get Contact CIS Settings action (under Xero).
  3. Fill in the fields below, then reference the result from later steps as {{getContactCisSettings.response.data}}.

Request

Path parameters

ContactIDstring (uuid)required

Unique identifier for a Contact

Headers

xero-tenant-idstringrequired

Xero identifier for Tenant

Response

Returns 200 with an object. Read it in later steps with {{getContactCisSettings.response.data.<field>}}.

CISSettingsarray<object>
CISEnabledboolean

Boolean that describes if the contact is a CIS Subcontractor

Ratenumber (double)

CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned

json
{
  "CISSettings": [
    {
      "CISEnabled": false,
      "Rate": 0
    }
  ]
}

Need more? See the Xero guide for connection setup and behaviour shared by every action.