Components of a Payable

When you call the Wingspan API to create or modify a payable, you must pass a series of parameters in the request body that structure the payment information. For more information on the Payables endpoint, see Payables API Reference.

PropertyUseData typeValueDescription
collaboratorIdRequiredStringDefined by you. For example: 123asd456qweUnique identifier representing the payee  for whom the invoice is created. You can find a collaborator ID by calling the GET /payments/collaborator API which returns a list of all Collaborators associated with your project.
The credit card processing fee. Applicable only when paying with a credit card, you indicate who pays this processing fee. The fee is passed to either yourself (clientPays), the payee (memberPays), or to yourself but as a percentage of the total. The data type for each value is either a number or null.
dueDate RequiredStringDefined by youThe date that the payable is due
currencyRequiredAny or null"USD", "CAD", etc.Define the currency that is used for the transaction.
The array of line items defines essential details about the invoice.
This is an optional parameter that, if selected, allocates an amount of the payment to an additional payee.
statusOptionalAny or null"Draft"
This parameter indicates the current status of the invoice. For more information, see Payment Lifecycle.
attachmentsOptionalObject or nullcustomAttachmentIdsUse this field to indicate if there is an attachment associated with the payment. This could be a receipt for additional supplies purchased, a photo of completed work, or another file that provides context or clarity for the payment. Use the POST/files/member/private/upload endpoint to upload files and generate a fileId. Enter the fileId in the attachments object to represent the customAttachmentIds. Attachments will be accessible by anyone with the invoice link. Do not include sensitive information.
acceptedPaymentMethodsOptionalArray of any or null"Credit"
This parameter indicates which payment method is provided to the client. One or all three can be listed.
Credit means that you can pay with a credit card.
Automated Clearing House (ACH) means that you fund your payroll with a bank account.
Manual means that you send a paper check to the Collaborator.
clientOptionalObjectclientIDThis is the identifier that Wingspan uses to associate an invoice with a client.
invoiceNotesOptionalStringDefined by youThe invoice notes attribute is used to include additional information about the invoice.
If you choose, you can include a late fee for your invoice. The late fee can be recurring.
lateFeeHandling Subparameters:
OptionalNumberDefined by youA percentage of the total amount of the payment.
lateFeeHandling Subparameters:
OptionalNumberDefined by youA fixed monetary amount that is added to the payment.
lateFeeHandling Subparameters:
daily: This parameter indicates that the action (like assessing a late fee) is performed every day. It implies a continuous, day-to-day frequency.

dayInInterval: This parameter is likely used to specify particular days within a given interval. For example, it could be used to indicate that the action should occur on the 1st and 15th day of an interval, where the interval could be a month, a quarter, etc.

endDate: This parameter specifies the final date when the recurring action (such as applying a late fee) will cease. It's used to set a boundary or limit on the duration of the frequency.

every: This is a general parameter used to define the recurrence of an action. It's often combined with a numerical value and a time unit (like "every 5 days") to specify how often the action should take place.

interval: This parameter typically refers to the time between each occurrence of the action. For example, an interval of '7' could imply a weekly occurrence if the unit is days, or a biannual occurrence if the unit is months.

startDate: This parameter indicates the initial date when the recurring action will begin. It sets the starting point for the frequency schedule.

twicePerMonth: This parameter specifies that the action should occur twice within each month. It's a specific frequency that's useful for more regular occurrences but with a frequency higher than monthly yet not as high as weekly.
labelsOptionalObjectDefined by youYou can use labels from the Labels Dictionary to help keep track and organize your invoices.
Depending on your preferences, you can use this parameter to configure how the invoice is sent to the client.
integrationOptionalObjectquickbooksIf you take advantage of the Wingspan-QuickBooks integration, you can link the invoice to your QuickBooks account by using this parameter.