ops (1.3.0)

Download OpenAPI specification:Download

Taxnexus Finance Microservice

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

CashReceipt

Delete a cash receipt

Delete cash receipt by ID

Authorizations:
query Parameters
id
string

Taxnexus Id of the record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Cash Receipts

Return a list of available Taxnexus Cash Receipts

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

cashReceiptId
string

Taxnexus Record Id of a Cash Receipt

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Cash Receipts

Create New Cash Receipts

Authorizations:
Request Body schema: application/json

A request with an array of Cash Receipot Objects

Array of objects (CashReceipt)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Put a list of Cash Receipts

Put a list of Cash Receipts

Authorizations:
Request Body schema: application/json

A request with an array of Cash Receipot Objects

Array of objects (CashReceipt)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

cors

cashReceiptOptions

CORS support

Responses

chargeOptions

CORS support

Responses

eftOptions

CORS support

Responses

invoiceOptions

CORS support

Responses

ordersOptions

CORS support

Responses

paymentMethodOptions

CORS support

Responses

poOptions

CORS support

Responses

productOptions

CORS support

Responses

productOptionsObservable

CORS support

Responses

quoteOptions

CORS support

Responses

taxInvoiceOptions

CORS support

Responses

taxOrderOptions

CORS support

Responses

taxPoOptions

CORS support

Responses

taxQuoteOptions

CORS support

Responses

Charge

Delete a Charge

Delete a Charge by ID

Authorizations:
query Parameters
id
string

Taxnexus Id of the record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Charges

Return a list of available Taxnexus Charges

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

chargeId
string

Taxnexus Record Id of a Charge

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Charges

Create New Charges

Authorizations:
Request Body schema: application/json

A request with an array of Charge Objects

Array of objects (Charge)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Put a list of Charges

Put a list of Charges

Authorizations:
Request Body schema: application/json

A request with an array of Charge Objects

Array of objects (Charge)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Eft

Get a list of Efts

Return a list of available Taxnexus Efts

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

eftId
string

Taxnexus Record Id of a EFT

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Efts

Create New Efts

Authorizations:
Request Body schema: application/json

A request with an array of EFT Objects

Array of objects (Eft)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Put a list of Efts

Put a list of Efts

Authorizations:
Request Body schema: application/json

A request with an array of EFT Objects

Array of objects (Eft)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Invoice

Delete an invoice

Delete an invoice by ID

Authorizations:
query Parameters
id
string

Taxnexus Id of the record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Invoices

Return a list of available Taxnexus Invoices

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

invoiceId
string

Taxnexus Record Id of an Invoice

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create a new Invoice

Create New Invoices

Authorizations:
Request Body schema: application/json

A request with an array of Invoice Objects

Array of objects (InvoiceBasic)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Put a list of Invoices

Put a list of Invoices

Authorizations:
Request Body schema: application/json

A request with an array of Invoice Objects

Array of objects (InvoiceBasic)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Order

Delete an Order

Delete an order by ID

Authorizations:
query Parameters
id
string

Taxnexus Id of the record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Orders

Return a list of Orders

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

orderId
string

Taxnexus Record Id of an Order

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Orders

Create new Orders

Authorizations:
Request Body schema: application/json

A request with an array of Order Objects

Array of objects (Order)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Orders

Update orders

Authorizations:
Request Body schema: application/json

A request with an array of Order Objects

Array of objects (Order)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

PaymentMethod

Delete a PaymentMethod

Delete a PaymentMethod by ID

Authorizations:
query Parameters
paymentMethodId
string

Taxnexus Record Id of a PaymentMethod

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of PaymentMethods

Return a list of available Taxnexus PaymentMethods

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

paymentMethodId
string

Taxnexus Record Id of a PaymentMethod

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new PaymentMethods

Create New PaymentMethods

Authorizations:
Request Body schema: application/json

A request with an array of Purchase Order Objects

Array of objects (PaymentMethod)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Put a list of PaymentMethods

Put a list of PaymentMethods

Authorizations:
Request Body schema: application/json

A request with an array of Purchase Order Objects

Array of objects (PaymentMethod)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

PurchaseOrder

Delete a PO

Delete a PO by ID

Authorizations:
query Parameters
id
string

Taxnexus Id of the record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Purchase Orders

Return a list of available Purchase Orders

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

purchaseOrderId
string

Taxnexus Record Id of a Company

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create a new Purchase Order

Create New Purchase Order

Authorizations:
Request Body schema: application/json

A request with an array of Purchase Order Objects

Array of objects (PurchaseOrder)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Upsert a list of Purchase Order

Upsert a list of Purchase Order

Authorizations:
Request Body schema: application/json

A request with an array of Purchase Order Objects

Array of objects (PurchaseOrder)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Product

Delete a Product

Delete Taxnexus Product record

Authorizations:
query Parameters
productId
string

Taxnexus Record Id of a Product

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Products

Return a list of all available Products

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

active
boolean

Retrieve active records?

productId
string

Taxnexus Record Id of a Product

productCode
string

Product Code of a Product

publish
boolean

Is this product published?

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {