Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wingspan Bulk Operations API

This category includes endpoints for managing bulk operations like bulk payables, bulk invoices, and bulk collaborator management.

Wingspan Bulk Operations API is one of 15 APIs that Wingspan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bulk Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 35 operations across 17 paths, and defines 48 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0-oas3.1.

Requests are made against 2 base URLs: https://api.wingspan.app, https://stagingapi.wingspan.app.

35 operations 17 paths 48 schemas 2 DELETE17 GET8 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0-oas3.1
Base URL
https://api.wingspan.app
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Wingspan Bulk Operations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 35

Across 17 paths, the API surfaces 35 operations — 2 DELETE, 17 GET, 8 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk Operations 35

This category includes endpoints for managing bulk operations like bulk payables, bulk invoices, and bulk collaborator management.

GET
/payments/bulk/payable/batch
Retrieve All Bulk Payable Batches
listPayableBatches → 200
POST
/payments/bulk/payable/batch
Initiate a New Bulk Payable Batch
createPayableBatch body → 200
GET
/payments/bulk/payable/batch/{batchId}
Retrieve Details of a Specific Bulk Payable Batch
getPayableBatch 1 param → 200
PATCH
/payments/bulk/payable/batch/{batchId}
Modify a Specific Bulk Payable Batch
updatePayableBatch 1 param body → 200
DELETE
/payments/bulk/payable/batch/{batchId}
Remove a Specific Bulk Payable Batch
deletePayableBatch 1 param → 200
GET
/payments/bulk/payable/batch/{batchId}/item
Retrieve all items from a specific bulk payable batch
listPayableBatchItems 1 param → 200
POST
/payments/bulk/payable/batch/{batchId}/item
Add a new item to a specific bulk payable batch
createPayableBatchItem 1 param body → 200
GET
/payments/bulk/payable/batch/{batchId}/import-summary
Fetch the import summary for a specific bulk payable batch
getPayableBatchItem 1 param → 200
GET
/payments/bulk/payable/batch/{batchId}/item/{batchItemId}
Retrieve a Specific Item from a Bulk Payable Batch
getSpecificPayableBatchItem 2 params → 200
PATCH
/payments/bulk/payable/batch/{batchId}/item/{batchItemId}
Modify a Specific Item in a Bulk Payable Batch
updateSpecificPayableBatchItem 2 params body → 200
GET
/payments/bulk/invoice/batch
Retrieve All Bulk Invoice Batches
listInvoiceBatches → 200
POST
/payments/bulk/invoice/batch
Initiate a New Bulk Invoice Batch
createInvoiceBatch body → 200
GET
/payments/bulk/invoice/batch/{batchId}
Retrieve details of a specific bulk invoice batch
getInvoiceBatch 1 param → 200
PATCH
/payments/bulk/invoice/batch/{batchId}
Modify the details of a specific bulk invoice batch
updateInvoiceBatch 1 param body → 200
GET
/payments/bulk/invoice/batch/{batchId}/item
Fetch all items from a specific bulk invoice batch
listSpecificInvoiceBatches 1 param → 200
POST
/payments/bulk/invoice/batch/{batchId}/item
Add a new item to a specific bulk invoice batch
createSpecificInvoiceBatch 1 param body → 200
GET
/payments/bulk/invoice/batch/{batchId}/item/{batchItemId}
Retrieve a specific item from a bulk invoice batch
getSpecificInvoiceBatch 2 params → 200
PATCH
/payments/bulk/invoice/batch/{batchId}/item/{batchItemId}
Modify a specific item within a bulk invoice batch
updateSpecificInvoiceBatch 2 params body → 200
GET
/payments/bulk/collaborator/batch
Fetch all bulk collaborator batches
listCollaboratorBatches → 200
POST
/payments/bulk/collaborator/batch
Initiate a new bulk collaborator batch.
createCollaboratorBatch body → 200
GET
/payments/bulk/collaborator/batch/{batchId}
Retrieve Details of a Specific Collaborator Batch
getCollaboratorBatch 1 param → 200
PATCH
/payments/bulk/collaborator/batch/{batchId}
Modify Details of a Bulk Collaborator Batch
updateCollaboratorBatch 1 param body → 200
DELETE
/payments/bulk/collaborator/batch/{batchId}
Remove a Specific Collaborator Batch
deleteCollaboratorBatch 1 param → 200
GET
/payments/bulk/collaborator/batch/{batchId}/item
Retrieve all items from a specific collaborator batch
listSpecificCollaboratorBatchItems 1 param → 200
POST
/payments/bulk/collaborator/batch/{batchId}/item
Append a new item to a specific collaborator batch
createSpecificCollaboratorBatchItem 1 param body → 200
GET
/payments/bulk/collaborator/batch/{batchId}/item/{batchItemId}
Retrieve details of a specific item from a collaborator batch
getSpecificCollaboratorBatchItem 2 params → 200
PATCH
/payments/bulk/collaborator/batch/{batchId}/item/{batchItemId}
Modify the details of a specific item within a collaborator batch
updateSpecificCollaboratorBatchItem 2 params body → 200
GET
/payments/bulk/client/batch
Retrieve all bulk client batches
listClientBatches → 200
POST
/payments/bulk/client/batch
Create a new bulk client batch
createClientBatch body → 200
GET
/payments/bulk/client/batch/{batchId}
Fetch Details of a Specific Item from a Client Batch
getClientBatch 1 param → 200
PATCH
/payments/bulk/client/batch/{batchId}
Modify Details of a Specific Item in a Client Batch
updateClientBatch 1 param body → 200
GET
/payments/bulk/client/batch/{batchId}/item
Retrieve All Items from a Client Batch
listClientBatchItems 1 param → 200
POST
/payments/bulk/client/batch/{batchId}/item
Add a New Item to a Client Batch
createClientBatchItem 1 param body → 200
GET
/payments/bulk/client/batch/{batchId}/item/{batchItemId}
Fetch Details of a Specific Item from a Client Batch
getClientBatchItem 2 params → 200
PATCH
/payments/bulk/client/batch/{batchId}/item/{batchItemId}
Modify Details of a Specific Item in a Client Batch
updateClientBatchItem 2 params body → 200

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are BulkInvoiceItem (29 properties), BulkPayableItem (26 properties), BulkCollaboratorItem (20 properties), BulkInvoiceItemUpdate (19 properties). Each schema is shown below with its type and property counts.

CompanyLinks
object
5 properties
BulkPayableBatchCreate
object
2 properties 1 required
BulkPayableImportSummary
object
10 properties 10 required
BulkInvoiceBatchCreate
object
2 properties 1 required
BulkInvoiceBatchUpdate
object
2 properties
4091c2911630f24a45153ca60a204edf3efba15902cef686d412c191e0c18cac
object
2 properties
87539cb97aa7616e350fc0d23c5a49177ea4c4a8bd00ec2a2cfd2a9a5c4e648a
object
6d0791223791444911cf73db8aa3782fc7b1c0b614b1873468fbf7182f9f9a11
object
5 properties
BulkInvoiceBatch
object
10 properties 9 required
BulkCollaboratorItemUpdate
object
10 properties
BulkBatchUpdate
object
2 properties
BulkBatchCreate
object
1 property
RedactedMember
object
2 properties 1 required
d750b2d9403b5bcbdb3c96c89f1cc713df563d587f16e5f39f5ab546c08a20a0
object
1 property
MemberClientFormW9Info
object
13 properties
UserRoles
object
2 properties 2 required
BulkPayableItem
object
26 properties 14 required
BulkInvoiceItemCreate
object
19 properties 5 required
BulkCollaboratorItem
object
20 properties 10 required
BulkClientBatch
object
9 properties 8 required
ff870c34e17f41323279d1c2fe8e2d03accac4d93d8aa050ddce7dbba094dbcb
object
5 properties
8cf19a7bc90727398c2780566a4070199559f4723ec14c01c448dc0356efffa1
object
2 properties
BulkPayableItemCreate
object
18 properties 5 required
CompanyPerson
object
2 properties 1 required
BulkPayableBatch
object
11 properties 10 required
BulkPayableItemUpdate
object
18 properties
Company
object
13 properties
64846136a354aa510825c1f23c3a978f4c816d8d4184311e7294a570f73727dc
object
2 properties
BulkPayableBatchUpdate
object
2 properties
757f4961b94334fd41cedc27262be7b14583377703cda6490b996969bd4e66c2
object
3 properties 3 required
BulkInvoiceItem
object
29 properties 14 required
BulkInvoiceItemUpdate
object
19 properties
LabelsDictionary
object
BulkCollaboratorBatch
object
10 properties 9 required
f6f2bd1a2fc7bad4e0d8f22345fc5f6699d096b7797b93575869c544a4fc5cef
object
2 properties
BulkClientItemCreate
object
8 properties
RedactedUser
object
6 properties
23d776fc12e56286a20f36065e4f942c43a28218a62eb2f211116c130deb74eb
object
4 properties
BulkClientItem
object
18 properties 10 required
Address
object
5 properties 4 required
InvoiceIntegrations
object
1 property
BulkCollaboratorItemCreate
object
10 properties
7996a6815c717c0e93865680b5cd47dec90314e97e4e7282bed7fc2f367bc051
object
1 property
9e97e63e736df301658ebeeab7f4fe84f3aeaa73800d3e4863801a3eb026df4b
object
1 property
FeeHandlingConfig
object
3 properties
MemberData
object
3 properties
BulkClientItemUpdate
object
8 properties
c1b9877fd1d35a4292006c3c09941c1c5c21bbe2e0e87488661804eebf2a3e4a
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wingspan-bulk-operations-api-openapi.yml Raw ↑

Other APIs Wingspan publishes across the network.

Wingspan 1099 Operations API
Wingspan Banking Management API
Wingspan Client Management API
Wingspan Collaborator Management API
Wingspan Custom Field Management API
Wingspan Deprecated API
Wingspan Document Signing and Eligibility API
Wingspan Invoice Management API
Wingspan Merchant Category Codes API
Wingspan Payables Management API
Wingspan Payroll Settings API
Wingspan Reporting and Analytics API