Skip to main content

Invoice Listing API

Updated

JSON is used to retrieve/display the fields within the OASIS Invoice Transaction Set (Invoice Listing). A JSON API performs the OASIS function of searching in the OASIS Invoice application using the "Find" feature and displaying the information in a logical, easily parsed format. The following areas will be covered:

  • Invoice Listing Fields
  • Find Fields 

Requirements:

  • Users must have O4. To learn more about moving forward with O4, contact OASIS Sales at sales@oasissalessoftware.com or 501-843-6750.
  • Users must create bearer tokens in O4 to authorize the call in their external API software.

 

Calls

Software-based calls

Define the OASIS Invoices to use for data extraction.

Format: A comma delimited list of any key/value pair for an OASIS Invoice listing works here. . . "FindObject":"<value>", "FindObject":"<value>"

Multiple Invoices Call

Multiple Invoices can be specified by the find criteria. But the Find criteria should be used to narrow the response content if many fields are being extracted.

"UpdateDate":"ThisYear:Today" – Every invoice within that time range would be brought in.

Example:

{
"Find": { "DBID":"*","UpdateDate":"ThisYear:Today"},
"Listing":"InvoiceID,Create Date,Kind,Related Order"
}

Results:

"Create Date": "2024-05-09 11.12.11",
"Related Order": "Test12346789",
"Kind": "Commissioned",
"InvoiceID": "Test12346789"
},
{
"Create Date": "2024-09-05 09.43.02",
"Related Order": "Test1234test",
"Kind": "Customer - Sell",
"InvoiceID": "Test1234test"
},
{
"Create Date": "2022-11-18 11.16.09",
"Related Order": "POTest1234321",
"Kind": "Customer - Sell",
"InvoiceID": "Test1234321"
},
{
"Create Date": "2024-03-13 10.14.42",
"Related Order": "Test123456",
"Kind": "Commissioned",
"InvoiceID": "Test123456"
},
{
"Create Date": "2024-05-01 10.48.43",
"Related Order": "POTest1234",
"Kind": "Commissioned",
"InvoiceID": "Test1234"
},

Single Invoice Call

A single invoice can be designated by including “DBID”:”value”,”InvoiceID”:”value” in the listing.

"DBID":"Test", "InvoiceID":"1234" – An Invoice with a Database ID of Test and a Invoice ID of 1234 (not Invoice Number!)

Example:

URL: <WebDatabaseURL>/API?&ajax=InvoiceListing

JSON POST method

{
"Find": { "DBID":"test1234","InvoiceID":"Test1234"},
"Listing":"InvoiceID,Create Date,Kind,Related Order"
}

Results:

"Listing": [
{
"Create Date": "2010-10-19",
"Related Order": "TestOrder",
"Kind": "Commissioned",
"InvoiceID": "Test1234"

 

Browser-Based Call

Below is how to make a browser based API call, you can do this for a single or multiples like a range of transactions. 

Multiple Invoices Call

You can make a call for multiple invoices but using a find with a range such as update date for example.

Example:

URL: <WebDatabaseURL>/API?&ajax=InvoiceListing&UpdateDate=This

Year:Today&Listing=InvoiceID,Create Date,Kind,Related Order,

Results:

"Create Date": "2024-05-09 11.12.11",
"Related Order": "Testing1234",
"Kind": "Commissioned",
"InvoiceID": "Testing1234"
},
{
"Create Date": "2024-09-05 09.43.02",
"Related Order": "Testing1234test",
"Kind": "Customer - Sell",
"InvoiceID": "Testing1234test"
},
{
"Create Date": "2022-11-18 11.16.09",
"Related Order": "POTesting123456789",
"Kind": "Customer - Sell",
"InvoiceID": "Testing123456789"

Single Invoice Call

Example:

URL: <WebDatabaseURL>/API?&ajax=InvoiceListing&Invoice=InvoiceID&Listing=Create Date,Kind,Related Order,InvoiceID

Results:

"Create Date": "2024-05-09 11.12.11",
"Related Order": "POTestcall",
"Kind": "Commissioned",
"InvoiceID": "Testcalling"

 

Listings

To find a specific "Invoice Listing" field(s), use the JSON "Find" function.

A group of JSON APIs perform the common OASIS function of searching in one of the OASIS applications using the "Find" feature and showing the columns available in the "Preferences" feature.

The result will be an object with an array with each returned row under the key "Listing" as found in the URL below:

https://{BASE_URL}/API?ajax=InvoiceListing&help=all

Listing fields:

  • DBID
  • InvoiceID
  • Manufacturer
  • Representatives
  • Customer
  • Resell Company
  • Credit
  • Kind
  • Create Workgroup
  • Create User
  • Create Date
  • Update User
  • Update Date
  • Print Lot Price
  • Project
  • Invoice Number
  • Order System
  • Related Order
  • Manufacturer Order
  • Due Date
  • Invoice Date
  • Invoice Status
  • Paid Status
  • Freight
  • Tax
  • Restock
  • Received Payments
  • Total
  • TotalTaxable
  • NonTaxable
  • TotalDeposit
  • ASO
  • BSID
  • Notes
  • Bill Name
  • Bill Line1
  • Bill Line2
  • Bill City
  • Bill State
  • Bill Zip
  • Bill County
  • Bill Country
  • Ship Name
  • Ship CO
  • Ship Line1
  • Ship Line2
  • Ship City
  • Ship State
  • Ship Zip
  • Ship County
  • Ship Country
  • Total Price
  • Total Earnings
  • Review User
  • Monitor User
  • Disputed
  • Disputed Amount
  • Disputed Notes
  • Assigned On
  • Resolved
  • Resolution Date
  • Fault
  • Received
  • Paid
  • Receivable
  • Payable
  • PO Entry Date
  • InternalNotes
  • ResolutionNotes
  • Dispute Date
  • Batch
  • Date Version
  • Terms
  • QuoteUserID
  • CSR
  • uri
  • Accounts
  • KEY_(insert search tag name)

Example: 

The listing part of the call is the bold and underlined part:

URL: <WebDatabaseURL>/ajax=InvoiceListing&UpdateDate=This Year:Today&Listing=InvoiceID,Create Date,Kind,Related Order.

This would result in giving you the data from the timeframe within the update date and list each listing shown in the bold text.

 

Finds

JSON is used to retrieve/display the fields within the "Invoice Listing" segment. 

A group of JSON APIs perform the OASIS function of searching in one of the OASIS applications using the "Find" feature and showing the columns available in the "Preferences" feature.

To retrieve a list of all "Invoice Listing" fields and "Find" searchable fields, use the following URL:

https://{BASE_URL}/API?ajax=InvoiceListing&help=all

Find Fields

  • InvoiceNumber
  • PO#
  • PONumber
  • ASO
  • MFGOrder
  • Project
  • InvoiceDate
  • UpdateDate
  • PaymentReceived
  • InvoiceEntry
  • InvoiceStatus
  • Disputed
  • Commissioned
  • Sell
  • Buy
  • HasPayment
  • NoPayments
  • HasReceivable 
  • HasRecievable (Calculated)
  • HasPayable
  • CloseSales
  • Deposit
  • Not DepositInvoice
  • NotDepositInvoice
  • DepositUsed
  • POStatus
  • OrderType
  • POEntry
  • CSR
  • Quoter
  • Account
  • Workgroup
  • ResellCompany
  • Manufacturer
  • ParentManufacturer
  • Customer
  • ParentCustomer
  • Specifiers
  • Representative

Example:

The bold and underlined part of the call below is the Find.

URL: <WebDatabaseURL>/ajax=InvoiceListing&UpdateDate=This Year:Today&Listing=InvoiceID,Create Date,Kind,Related Order.

This part of bold text is the criteria you are using to find the invoices you are looking for.

Results:

{
"Create Date": "2024-09-05 09.43.02",
"Related Order": "POTestingABC",
"Kind": "Customer - Sell",
"InvoiceID": "TestingABC"
},
{
"Create Date": "2022-11-18 11.16.09",
"Related Order": "POTestingABCDEFG",
"Kind": "Customer - Sell",
"InvoiceID": "TestingABCDEFG"
},
{
"Create Date": "2024-03-13 10.14.42",
"Related Order": "POTestingABCXYZ",
"Kind": "Commissioned",
"InvoiceID": "TestingABCXYZ"
},

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk