Wingspan Invoice Management API

Covers endpoints related to invoice creation, retrieval, and management. This includes both member and client invoices, along with specific actions like sending invoices by email and managing invoice templates.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 24 operations across 14 paths, and defines 93 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.

24 operations 14 paths 93 schemas 2 DELETE9 GET4 PATCH9 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

Contact

Wingspan API Support

License

UNLICENSED

View terms

Resource Areas

Authentication & Security 1

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

Paths & Operations 24

Across 14 paths, the API surfaces 24 operations — 2 DELETE, 9 GET, 4 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Invoice Management 24

Covers endpoints related to invoice creation, retrieval, and management. This includes both member and client invoices, along with specific actions like sending invoices by email…

GET

/payments/invoice

Retrieve All Member Invoices

getMemberInvoices → 200

POST

/payments/invoice

Initiate New Invoice for a Member

createInvoice body → 200

GET

/payments/invoice/{id}

Fetch Invoice by ID

getInvoice 1 param → 200

PATCH

/payments/invoice/{id}

Modify Existing Invoice Details

updateInvoice 1 param body → 200

DELETE

/payments/invoice/{id}

Remove Invoice Record by ID

deleteInvoice 1 param → 200

GET

/payments/client/invoice

Retrieve All Invoices Generated by a Client

listGeneratedInvoices → 200

POST

/payments/client/invoice

Generate a New Invoice on Behalf of the Client

createGeneratedInvoice body → 200

GET

/payments/client/invoice/{id}

Fetch Specific Client-Generated Invoice by ID

getGeneratedInvoice 1 param → 200

PATCH

/payments/client/invoice/{id}

Modify an Existing Client-Generated Invoice

updateGeneratedInvoice 1 param body → 200

POST

/payments/client/invoice/{invoice_id}/pay

Execute Payment for a Client-Generated Invoice

executeClientInvoicePayment 1 param body → 200

GET

/payments/invoice-template

Retrieve all available invoice templates

listInvoiceTemplates → 200

POST

/payments/invoice-template

Create a new invoice template

createInvoiceTemplate body → 200

GET

/payments/invoice-template/{id}

Retrieve a specific invoice template by ID

getInvoiceTemplate 1 param → 200

PATCH

/payments/invoice-template/{id}

Modify details of an existing invoice template

updateInvoiceTemplate 1 param body → 200

DELETE

/payments/invoice-template/{id}

Remove a specific invoice template

deleteInvoiceTemplate 1 param → 200

GET

/payments/client/invoice-template

Retrieve all client-generated invoice templates

listClientInvoiceTemplates → 200

POST

/payments/client/invoice-template

Create a new client-generated invoice template

createClientInvoiceTemplate body → 200

GET

/payments/client/invoice-template/{id}

Fetch a specific client-generated invoice template by ID

getClientInvoiceTemplate 1 param → 200

PATCH

/payments/client/invoice-template/{id}

Modify a client-generated invoice template

updateClientInvoiceTemplate 1 param body → 200

POST

/payments/invoice/{invoice_id}/generate

Generate a PDF for a specific invoice

generateSpecificInvoice 1 param → 200

POST

/payments/invoice/{invoice_id}/send

Send an invoice by email

sendInvoiceEmail 1 param → 200

POST

/payments/invoice/{invoice_id}/refund

Refund a deposited invoice

refundDepositedInvoice 1 param body → 200

GET

/payments/client/invoice/{invoice_id}/fees

Retrieve Fees Associated with a Client's Invoice

getInvoiceFees 1 param → 200

POST

/payments/invoice/test/create

Generate Test Invoice for a Client

generateTestInvoice body → 200

Schemas 93

The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are Invoice (46 properties), InvoiceEvents (40 properties), ClientInvoice (40 properties), MemberClient (31 properties). Each schema is shown below with its type and property counts.

InvoiceTemplateCreateRequest

object

8 properties 2 required

InvoicePayoutDestination

object

9 properties 6 required

InvoiceRefundDestination

object

11 properties 7 required

MemberClientForm1099Balances

object

13 properties 8 required

Frequency

object

7 properties 1 required

InvoiceAppliedDeductions

object

4 properties 3 required

InvoiceCollaborator

object

5 properties 4 required

InvoiceTemplateUpdateRequest

object

11 properties

Fees

object

2 properties

Form1099Events

object

8 properties

InvoiceEvents

object

40 properties

DocumentFiles

object

2 properties

InvoiceLineItemsCreateRequest

object

10 properties

ClientOptions

object

4 properties

ClientInvoiceTemplateCreateRequest

object

13 properties 4 required

InvoicePayment

object

11 properties 10 required

LabelsDictionary

object

InvoiceNotificationPreferences

object

3 properties 1 required

facb8048736dba546c4c76242d9f8c7111011a7a7483528f37d80226698a1f2b

object

3 properties

6d0791223791444911cf73db8aa3782fc7b1c0b614b1873468fbf7182f9f9a11

object

5 properties

ClientInvoice

object

40 properties 23 required

CompanyLinks

object

5 properties

MemberClientEvents

object

2 properties

Form1099Correction

object

8 properties

ClientInvoiceDataCreateRequest

object

4 properties 1 required

87539cb97aa7616e350fc0d23c5a49177ea4c4a8bd00ec2a2cfd2a9a5c4e648a

object

fa804b4efa97e487035ead1834462b69564f5e4ebbbd376106a1847d1c1aa4f4

object

2 properties

InvoiceMetadata

object

5 properties

Invoice

object

46 properties 20 required

ExternalIdsQuickbooksData

object

6 properties 2 required

MemberClientFormW9Info

object

13 properties

UserRoles

object

2 properties 2 required

InvoiceCollaboratorCreateRequest

object

4 properties 4 required

BankAccount

object

4 properties 2 required

36b041d426951ffff76360faf03ef8ae938bed9739e6ad9f51acb982782296a2

object

1 property

InvoiceDataCreateRequest

object

13 properties 2 required

Company

object

13 properties

TestInvoiceCreate

object

2 properties 2 required

PayRequest

object

3 properties

InvoicePdfGenerationResponse

object

2 properties 2 required

fdde61b278ad2b0bef3e1f411d3749ff7bc345ae633a85eb25e5990d251fb3a9

object

5 properties

InvoiceIntegrations

object

1 property

Address

object

5 properties 4 required

InvoiceFeeCalculation

object

1 property 1 required

FeeHandlingConfig

object

3 properties

ExternalIdsBulkImport

object

1 property

InvoiceAmountDetails

object

9 properties 8 required

ExternalIds

object

3 properties

3190685832a4970525ea5b0803efff0b36a0202062e1fd8a0bc187acbe156461

object

1 property

ClientInvoiceUpdateRequest

object

2 properties

ClientInvoiceTemplateUpdateRequest

object

3 properties 1 required

InvoiceCollaboratorUpdateRequest

object

2 properties

LateFeeConfigUpdate

object

3 properties

PaymentInfo

object

5 properties 1 required

b9789f45f8c8070ff38a64d80c2e4a8732ddaf329e46546474400d26f84c0f1c

object

2 properties

MemberClientWireAccount

object

4 properties 2 required

Fee

object

2 properties 1 required

DocumentResponse

object

9 properties 7 required

ProcessingFees

object

2 properties

InvoiceTemplate

object

19 properties 9 required

ScheduleDate

object

5 properties 2 required

ExternalIdsQuickbooks

object

f6f2bd1a2fc7bad4e0d8f22345fc5f6699d096b7797b93575869c544a4fc5cef

object

2 properties

RedactedUser

object

6 properties

23d776fc12e56286a20f36065e4f942c43a28218a62eb2f211116c130deb74eb

object

4 properties

MemberClient

object

31 properties 25 required

7996a6815c717c0e93865680b5cd47dec90314e97e4e7282bed7fc2f367bc051

object

1 property

InvoiceCreateRequest

object

17 properties 4 required

9e97e63e736df301658ebeeab7f4fe84f3aeaa73800d3e4863801a3eb026df4b

object

1 property

MemberData

object

3 properties

InvoiceLineItem

object

13 properties 9 required

FrequencyUpdate

object

7 properties

InvoiceRefundEvents

object

3 properties

ScheduleDateUpdate

object

3 properties

3d33fba3f009de957b3be92fba006d6383af7e39f823cc1fd213506f6205100f

object

1 property

8a9c6cb49482a98cdd603ff09858cdc3e5ef6ad9807c876c4161d925a96694a5

object

3 properties

InvoiceAttachments

object

5 properties

InvoiceWithholdings

object

1 property

ClientData

object

3 properties

6ad3f4f624fb518510130e879729b00ed8c237d1cebc5477abf34ac340a6424d

object

2 properties

ClientInvoiceTemplate

object

14 properties 9 required

MemberClientRequirementResponse

object

9 properties 4 required

RedactedMember

object

2 properties 1 required

InvoiceUpdateRequest

object

17 properties

CompanyPerson

object

2 properties 1 required

DocumentEvents

object

2 properties

MemberOptions

object

4 properties

LateFeeConfig

object

3 properties 1 required

InvoiceAttachmentFile

object

2 properties 2 required

14abbd45a54a2847207e8ddfaeb5d4bc82ffb855d63772d79e0c5fe04e9b9b01

object

2 properties 2 required

InvoiceRefundRequest

object

2 properties 1 required

ClientInvoiceCreateRequest

object

10 properties 4 required

d86c1fba5267ac3d9ce2954a6e46b70e471c0f91a44abbe94565ae50e6e9e863

object

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Wingspan publishes across the network.

Wingspan 1099 Operations API

AE Profile APIs.io

Wingspan Banking Management API

AE Profile APIs.io

Wingspan Bulk Operations API

AE Profile APIs.io

Wingspan Client Management API

AE Profile APIs.io

Wingspan Collaborator Management API

AE Profile APIs.io

Wingspan Custom Field Management API

AE Profile APIs.io

Wingspan Deprecated API

AE Profile APIs.io

Wingspan Document Signing and Eligibility API

AE Profile APIs.io

Wingspan Merchant Category Codes API

AE Profile APIs.io

Wingspan Payables Management API

AE Profile APIs.io

Wingspan Payroll Settings API

AE Profile APIs.io

Wingspan Reporting and Analytics API

AE Profile APIs.io

#Invoice Management

← Back to W APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Wingspan Invoice Management API

Metadata

Authentication & Security 1

Paths & Operations 24

Schemas 93

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Wingspan Invoice Management API

Metadata

Authentication & Security 1

Paths & Operations 24

Schemas 93

Specification

Source

More from Wingspan 12

API Details

Provider

Explore more