Payroll settings

Payroll settings are configured during your initial account set up. However, you can always change payroll settings in the application or by using the Wingspan API.

When configuring payroll settings, you can set your payroll schedule by defining the day(s) of the month when your Collaborators are paid, the Paid Date. By default, payroll processes two business days before the pay date on the Payroll Date. You can choose from:

• Monthly: The payment(s) will be received on the last day of each month.
• Semi-Monthly: The payment(s) will be received on the 15th and last day of each month.
• Everyday: The payment(s) will be received daily.
• Weekly: You decide which day of the week, and the weekly frequency.

Weekend and Holidays

If Payroll Date falls on a weekend or a holiday, it runs on the preceding business day. For example, if it falls on Saturday, the payment runs on Friday.

If the Check Date falls on a weekend or a holiday, it is deposited the next business day. For example, if the 15th is a Sunday, the Check Date will be the 16th.

During US bank holidays, the payroll schedule might be updated to accommodate.

Payables in payroll runs

By design, only approved Payable invoices are included in a payroll run. However, this means that all approved payables are included on the payroll run regardless of the Payable invoice’s due date. Depending on your needs, you might want to only pay approved invoices when due. You can control this setting in the application or with the API. If you choose, approved payables are only paid at the last possible payroll such that the payment arrives before the Due Date. Otherwise, all approved payables are paid out at the next payroll run.

To find your payroll setting by using the API

To find your payroll setting by using the API, you need to call two API endpoints. The first endpoint, /payments/memberClient, is used to retrieve your client ID. The client ID must be passed in the URL of the /payments/payroll-settings/{id} endpoint. That is the endpoint that is used to retrieve your payroll settings.

1. Retrieve your clientID

   Endpoint

   GET https://api.wingspan.app/payments/memberClient

   Headers

   • accept: application/json
   • Content-Type: application/json
   • authorization: Bearer <YOUR TOKEN>

   Body

   There is nothing needed in the request bod

   Response

   Upon a successful request, the API will return a status code of 200.

   Response Body

   The response will be an array of memberClient objects. The example has been modified for the purposes of retrieving the clientId.

   • clientId (string, required): A unique identifier associated with each client.
   • createdAt (string, required): A timestamp indicating when the memberClient object was created. It follows the ISO 8601 date-time format: YYYY-MM-DDTHH:MM:SSZ.

   Example response

   JSX

   {
     "clientId": "<unique_client_identifier>",
     "createdAt": "<timestamp>"
   }
   

2. Retrieve payroll settings

   Now that you have the clientId, you can update your payroll settings with the /payments/payroll-settings/{id} endpoint. You must pass the clientId in the {id} section of the URL.

   Endpoint:

   PATCH https://api.wingspan.app/payments/payroll-settings/{id}

   Headers

   • accept: application/json
   • content-type: application/json
   • authorization: Bearer <YOUR TOKEN>

   Body

   There is nothing needed in the request body.

   Response

   Upon a successful request, the API returns a status code of 200 as well as your current payroll settings. For more information about the payroll setting endpoints, see /payments/memberClient and /payments/payroll-settings/{id}.