Wingspan Bulk Operations API
This category includes endpoints for managing bulk operations like bulk payables, bulk invoices, and bulk collaborator management.
This category includes endpoints for managing bulk operations like bulk payables, bulk invoices, and bulk collaborator management.
openapi: 3.1.0
info:
title: Wingspan Payments 1099 Operations Bulk Operations API
description: Payments
termsOfService: https://www.wingspan.app
contact:
name: Wingspan API Support
url: https://www.wingspan.app
email: support@wingspan.app
license:
name: UNLICENSED
url: https://UNLICENSED
version: 1.0.0-oas3.1
servers:
- url: https://api.wingspan.app
description: Wingspan's Payments API in Production
x-speakeasy-server-id: prod
- url: https://stagingapi.wingspan.app
description: Wingspan's Payments API in Staging
x-speakeasy-server-id: staging
security:
- BearerAuth: []
tags:
- name: Bulk Operations
description: This category includes endpoints for managing bulk operations like bulk payables, bulk invoices, and bulk collaborator management.
paths:
/payments/bulk/payable/batch:
get:
summary: Retrieve All Bulk Payable Batches
operationId: listPayableBatches
x-speakeasy-name-override: list_payable
tags:
- Bulk Operations
description: Fetches a list of all the batches created for bulk payables, providing an overview of the bulk payment operations.
responses:
'200':
description: A list of bulk payable batches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkPayableBatch'
post:
summary: Initiate a New Bulk Payable Batch
operationId: createPayableBatch
x-speakeasy-name-override: create_payable
tags:
- Bulk Operations
description: Creates a new batch for importing multiple payables at once, streamlining the bulk payment operations.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatchCreate'
responses:
'200':
description: A batch of items for importing as payables
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatch'
/payments/bulk/payable/batch/{batchId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve Details of a Specific Bulk Payable Batch
operationId: getPayableBatch
x-speakeasy-name-override: get_payable
tags:
- Bulk Operations
description: Fetches detailed information of a specific batch created for bulk payables, using the provided batch ID.
responses:
'200':
description: A batch of items for importing as payables
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatch'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Modify a Specific Bulk Payable Batch
operationId: updatePayableBatch
x-speakeasy-name-override: update_payable
tags:
- Bulk Operations
description: Updates the information or items of a specific bulk payable batch, given its unique batch ID.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatchUpdate'
responses:
'200':
description: A batch of items for importing as payables
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatch'
delete:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Remove a Specific Bulk Payable Batch
operationId: deletePayableBatch
x-speakeasy-name-override: delete_payable
tags:
- Bulk Operations
description: Deletes a specific batch for bulk payables, using the provided batch ID, preventing any further operations on it.
responses:
'200':
description: A batch of items for importing as payables
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableBatch'
/payments/bulk/payable/batch/{batchId}/item:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve all items from a specific bulk payable batch
operationId: listPayableBatchItems
x-speakeasy-name-override: list_batch_item
tags:
- Bulk Operations
description: Fetches and lists all individual payable items associated with a specified bulk payable batch. Useful for tracking and verifying batch details.
responses:
'200':
description: A list of bulk payable items
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkPayableItem'
post:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Add a new item to a specific bulk payable batch
operationId: createPayableBatchItem
x-speakeasy-name-override: create_batch_item
tags:
- Bulk Operations
description: Allows for the creation and addition of a new individual payable item into an existing bulk payable batch. This enhances batch management and payable tracking.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableItemCreate'
responses:
'200':
description: An item that will be converted into a payable
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableItem'
/payments/bulk/payable/batch/{batchId}/import-summary:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Fetch the import summary for a specific bulk payable batch
operationId: getPayableBatchItem
x-speakeasy-name-override: get_batch_item
tags:
- Bulk Operations
description: Provides an overview and summary of the import process for a given bulk payable batch, allowing for tracking of imported items, errors, and other relevant batch statistics.
responses:
'200':
description: Summary of the bulk payable import
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableImportSummary'
/payments/bulk/payable/batch/{batchId}/item/{batchItemId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Retrieve a Specific Item from a Bulk Payable Batch
operationId: getSpecificPayableBatchItem
x-speakeasy-name-override: get_specific
tags:
- Bulk Operations
description: Fetches detailed information of a specific item within a bulk payable batch, using both the batch ID and the item ID.
responses:
'200':
description: An item that will be converted into a payable
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableItem'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Modify a Specific Item in a Bulk Payable Batch
operationId: updateSpecificPayableBatchItem
x-speakeasy-name-override: update_specific
tags:
- Bulk Operations
description: Updates the details or status of a specific item within a bulk payable batch, given both the batch ID and the item ID.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableItemUpdate'
responses:
'200':
description: An item that will be converted into a payable
content:
application/json:
schema:
$ref: '#/components/schemas/BulkPayableItem'
/payments/bulk/invoice/batch:
get:
summary: Retrieve All Bulk Invoice Batches
operationId: listInvoiceBatches
x-speakeasy-name-override: list
tags:
- Bulk Operations
description: Fetches a list of all the batches created for bulk invoices, providing an overview of the bulk invoicing operations.
responses:
'200':
description: A list of bulk invoice batches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkInvoiceBatch'
post:
summary: Initiate a New Bulk Invoice Batch
operationId: createInvoiceBatch
x-speakeasy-name-override: create
tags:
- Bulk Operations
description: Creates a new batch for importing multiple invoices at once, streamlining the bulk invoicing operations.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceBatchCreate'
responses:
'200':
description: A batch of items for importing as invoices
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceBatch'
/payments/bulk/invoice/batch/{batchId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve details of a specific bulk invoice batch
operationId: getInvoiceBatch
x-speakeasy-name-override: get
tags:
- Bulk Operations
description: Allows for the retrieval of a specified batch of bulk invoices by providing its unique batch identifier.
responses:
'200':
description: A batch of items for importing as invoices
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceBatch'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Modify the details of a specific bulk invoice batch
operationId: updateInvoiceBatch
x-speakeasy-name-override: update
tags:
- Bulk Operations
description: Enables the user to update or modify the attributes of a given batch of bulk invoices by specifying its unique batch identifier.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceBatchUpdate'
responses:
'200':
description: A batch of items for importing as invoices
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceBatch'
/payments/bulk/invoice/batch/{batchId}/item:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Fetch all items from a specific bulk invoice batch
operationId: listSpecificInvoiceBatches
x-speakeasy-name-override: list_specific_invoice
tags:
- Bulk Operations
description: Provides a list of all the items within a specified batch of bulk invoices, identified by its unique batch identifier.
responses:
'200':
description: A list of bulk invoice items
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkInvoiceItem'
post:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Add a new item to a specific bulk invoice batch
operationId: createSpecificInvoiceBatch
x-speakeasy-name-override: create_specific_invoice
tags:
- Bulk Operations
description: Allows users to append a new item to a given batch of bulk invoices by supplying its unique batch identifier and the details of the new item.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceItemCreate'
responses:
'200':
description: An item that will be converted into a invoice
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceItem'
/payments/bulk/invoice/batch/{batchId}/item/{batchItemId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Retrieve a specific item from a bulk invoice batch
operationId: getSpecificInvoiceBatch
x-speakeasy-name-override: get_specific_invoice
tags:
- Bulk Operations
description: Fetches detailed information about a specific item located within a designated bulk invoice batch. Useful for obtaining particular item data without browsing the entire batch.
responses:
'200':
description: An item that will be converted into a invoice
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceItem'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Modify a specific item within a bulk invoice batch
operationId: updateSpecificInvoiceBatch
x-speakeasy-name-override: update_specific_invoice
tags:
- Bulk Operations
description: Allows for updates or edits to be made to a specific items details within an existing bulk invoice batch. Enhances the flexibility and management of invoice data.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceItemUpdate'
responses:
'200':
description: An item that will be converted into a invoice
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInvoiceItem'
/payments/bulk/collaborator/batch:
get:
summary: Fetch all bulk collaborator batches
operationId: listCollaboratorBatches
x-speakeasy-name-override: list_collaborator
tags:
- Bulk Operations
description: Provides a list of all existing bulk collaborator batches, allowing users to view and manage batches that have been created for collaboration purposes.
responses:
'200':
description: A list of bulk collaborator batches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkCollaboratorBatch'
post:
summary: Initiate a new bulk collaborator batch.
operationId: createCollaboratorBatch
x-speakeasy-name-override: create_collaborator
tags:
- Bulk Operations
description: Enables the creation of a new bulk collaborator batch, facilitating the bulk management and addition of collaborators for various projects or tasks.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkBatchCreate'
responses:
'200':
description: A batch of items for importing as collaborators
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorBatch'
/payments/bulk/collaborator/batch/{batchId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve Details of a Specific Collaborator Batch
operationId: getCollaboratorBatch
x-speakeasy-name-override: get_collaborator
tags:
- Bulk Operations
description: Fetches detailed information of a specific bulk collaborator batch, using the provided batch ID.
responses:
'200':
description: A batch of items for importing as collaborators
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorBatch'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Modify Details of a Bulk Collaborator Batch
operationId: updateCollaboratorBatch
x-speakeasy-name-override: update_collaborator
tags:
- Bulk Operations
description: Allows for updating or altering the details and items within a specific bulk collaborator batch using the given batch ID.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkBatchUpdate'
responses:
'200':
description: A batch of items for importing as collaborators
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorBatch'
delete:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Remove a Specific Collaborator Batch
operationId: deleteCollaboratorBatch
x-speakeasy-name-override: delete_collaborator
tags:
- Bulk Operations
description: Deletes a specific bulk collaborator batch using its unique identifier. Once deleted, the batch cannot be recovered.
responses:
'200':
description: A batch of items for importing as collaborators
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorBatch'
/payments/bulk/collaborator/batch/{batchId}/item:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve all items from a specific collaborator batch
operationId: listSpecificCollaboratorBatchItems
x-speakeasy-name-override: list_specific_collaborator_item
tags:
- Bulk Operations
description: Provides a comprehensive list of items present within a specified batch of collaborators, identifiable through its unique batch identifier.
responses:
'200':
description: A list of bulk collaborator items
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkCollaboratorItem'
post:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Append a new item to a specific collaborator batch
operationId: createSpecificCollaboratorBatchItem
x-speakeasy-name-override: create_specific_collaborator_item
tags:
- Bulk Operations
description: Allows for the addition of a new item to an existing batch of collaborators by providing the batchs unique identifier and item details.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorItemCreate'
responses:
'200':
description: An item that will be converted into a collaborator
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorItem'
/payments/bulk/collaborator/batch/{batchId}/item/{batchItemId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Retrieve details of a specific item from a collaborator batch
operationId: getSpecificCollaboratorBatchItem
x-speakeasy-name-override: get_specific_collaborator_item
tags:
- Bulk Operations
description: Enables fetching of detailed information about an individual item from a specified batch of collaborators using both the batch and item unique identifiers.
responses:
'200':
description: An item that will be converted into a collaborator
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorItem'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Modify the details of a specific item within a collaborator batch
operationId: updateSpecificCollaboratorBatchItem
x-speakeasy-name-override: update_specific_collaborator_item
tags:
- Bulk Operations
description: Provides the functionality to update or alter the attributes of an item present in a given collaborator batch using the unique identifiers for both the batch and the item.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorItemUpdate'
responses:
'200':
description: An item that will be converted into a collaborator
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCollaboratorItem'
/payments/bulk/client/batch:
get:
summary: Retrieve all bulk client batches
operationId: listClientBatches
x-speakeasy-name-override: list_client
tags:
- Bulk Operations
description: Provides an overview of all existing bulk client batches, allowing users to quickly ascertain and manage batches created for the purpose of client onboarding or import.
responses:
'200':
description: A list of bulk client batches
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkClientBatch'
post:
summary: Create a new bulk client batch
operationId: createClientBatch
x-speakeasy-name-override: create_client
tags:
- Bulk Operations
description: Initiates the creation of a fresh bulk client batch, streamlining the process of adding multiple clients in one go.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkBatchCreate'
responses:
'200':
description: A batch of items for importing as clients
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientBatch'
/payments/bulk/client/batch/{batchId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Fetch Details of a Specific Item from a Client Batch
operationId: getClientBatch
x-speakeasy-name-override: get_client
tags:
- Bulk Operations
description: Retrieves the detailed information of a specific item within the bulk client batch using both batch and item unique identifiers.
responses:
'200':
description: A batch of items for importing as clients
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientBatch'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Modify Details of a Specific Item in a Client Batch
operationId: updateClientBatch
x-speakeasy-name-override: update_client
tags:
- Bulk Operations
description: Allows modification of the details of a specific item within the bulk client batch, using the provided item and batch identifiers.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkBatchUpdate'
responses:
'200':
description: A batch of items for importing as clients
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientBatch'
/payments/bulk/client/batch/{batchId}/item:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Retrieve All Items from a Client Batch
operationId: listClientBatchItems
x-speakeasy-name-override: list_client_item
tags:
- Bulk Operations
description: Fetches all items present in the specified bulk client batch, providing a comprehensive view of all client data in the batch.
responses:
'200':
description: A list of bulk client items
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkClientItem'
post:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
summary: Add a New Item to a Client Batch
operationId: createClientBatchItem
x-speakeasy-name-override: create_client_item
tags:
- Bulk Operations
description: Inserts a new item into the specified bulk client batch, allowing for further expansion of client data within the batch.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientItemCreate'
responses:
'200':
description: An item that will be converted into a client
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientItem'
/payments/bulk/client/batch/{batchId}/item/{batchItemId}:
get:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Fetch Details of a Specific Item from a Client Batch
operationId: getClientBatchItem
x-speakeasy-name-override: get_client_item
tags:
- Bulk Operations
description: Retrieves the detailed information of a specific item within the bulk client batch using both batch and item unique identifiers.
responses:
'200':
description: An item that will be converted into a client
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientItem'
patch:
parameters:
- in: path
required: true
name: batchId
description: Unique identifier for a batch
schema:
type: string
- in: path
required: true
name: batchItemId
description: Unique identifier for an item in a batch
schema:
type: string
summary: Modify Details of a Specific Item in a Client Batch
operationId: updateClientBatchItem
x-speakeasy-name-override: update_client_item
tags:
- Bulk Operations
description: Allows modification of the details of a specific item within the bulk client batch, using the provided item and batch identifiers.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientItemUpdate'
responses:
'200':
description: An item that will be converted into a client
content:
application/json:
schema:
$ref: '#/components/schemas/BulkClientItem'
components:
schemas:
CompanyLinks:
type: object
properties:
instagramUrl:
type:
- string
- 'null'
linkedInUrl:
type:
- string
- 'null'
otherUrl:
type:
- string
- 'null'
twitterUrl:
type:
- string
- 'null'
websiteUrl:
type:
- string
- 'null'
BulkPayableBatchCreate:
type: object
properties:
processingStrategy:
type: string
enum:
- Merge
- Single
labels:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/LabelsDictionary'
required:
- processingStrategy
BulkPayableImportSummary:
type: object
properties:
deductionCollaboratorsCount:
type: number
netImportAmount:
type: number
payableCollaboratorsCount:
type: number
toBeCreatedDeductionsCount:
type: number
toBeCreatedPayablesCount:
type: number
toBeUpdatedDeductionsCount:
type: number
toBeUpdatedPayablesCount:
type: number
totalDeductionsAmount:
type: number
totalPayableItems:
type: number
totalPayablesAmount:
type: number
required:
- deductionCollaboratorsCount
- netImportAmount
- payableCollaboratorsCount
- toBeCreatedDeductionsCount
- toBeCreatedPayablesCount
- toBeUpdatedDeductionsCount
- toBeUpdatedPayablesCount
- totalDeductionsAmount
- totalPayableItems
- totalPayablesAmount
BulkInvoiceBatchCreate:
type: object
properties:
processingStrategy:
type: string
enum:
- Merge
- Single
labels:
oneOf:
- type: 'null'
- $ref: '#/components/schemas/LabelsDictionary'
required:
- processingStrategy
BulkInvoiceBatchUpdate:
type: object
properties:
labels:
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wingspan/refs/heads/main/openapi/wingspan-bulk-operations-api-openapi.yml