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.
Property | Use | Data type | Value | Description |
---|---|---|---|---|
collaboratorId | Required | String | Defined by you. For example: 123asd456qwe | Unique 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. |
creditFeeHandling | Required | Object | memberPays | 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 | Required | String | Defined by you | The date that the payable is due |
currency | Required | Any or null | "USD", "CAD", etc. | Define the currency that is used for the transaction. |
lineItems | Required | Array | description | The array of line items defines essential details about the invoice. |
collaborators | Optional | Array | memberClientId | This is an optional parameter that, if selected, allocates an amount of the payment to an additional payee. |
status | Optional | Any or null | "Draft" | This parameter indicates the current status of the invoice. For more information, see Payment Lifecycle. |
attachments | Optional | Object or null | customAttachmentIds | Use 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. |
acceptedPaymentMethods | Optional | Array of any or null | "Credit" | This parameter indicates which payment method is provided to the client. One or all three can be listed.
|
client | Optional | Object | clientID | This is the identifier that Wingspan uses to associate an invoice with a client. |
invoiceNotes | Optional | String | Defined by you | The invoice notes attribute is used to include additional information about the invoice. |
lateFeeHandling | Optional | Object | lateFeePercentage | If you choose, you can include a late fee for your invoice. The late fee can be recurring. |
lateFeeHandling Subparameters: | Optional | Number | Defined by you | A percentage of the total amount of the payment. |
lateFeeHandling Subparameters: | Optional | Number | Defined by you | A fixed monetary amount that is added to the payment. |
lateFeeHandling Subparameters: | Optional | Array | daily |
|
labels | Optional | Object | Defined by you | You can use labels from the Labels Dictionary to help keep track and organize your invoices. |
notificationPreferences | Optional | Object | sendInvoice | Depending on your preferences, you can use this parameter to configure how the invoice is sent to the client. |
integration | Optional | Object | quickbooks | If you take advantage of the Wingspan-QuickBooks integration, you can link the invoice to your QuickBooks account by using this parameter. |
Updated 5 days ago