Use this API to find invoices in the Dsco Platform and return a single page of the results.

 Reference the PagedInvoiceResult JSON Object Jand the Invoice JSON Object.

 The Find Invoices API documents the API's URL, it's arguments/return values and how to interact with it (GET, POST, PUT, etc.) in the Dsco Interactive Playground.

 Input Params

The Find Invoices API documents the search params that may be passed in.  When searching, you must provide either a single ID param (dscoInvoiceId, invoiceId, poNumber, sellerInvoiceNumber, supplierOrderNumber, consumerOrderNumber) or one of the period-based filters (invoicesCreatedInLast, invoicesUpdatedInLast, invoicesCreatedSince, invoicesUpdatedSince). Below you will find additional detail on the input params.

  • pageNumber 
    Use this param to specify which page of results is desired.  Initially, call this API with the pageNumber set to 1.  The response will include the total number of pages of results as the pageCount field, allowing the developer to make additional calls to this API to retrieve all pages of results.  Please note that every call to this API returns the pageCount field in the returned object and the developer should verify that the pageCount does not change as he iterates through the pages.  The pageCount would only change if the number of invoices is changing in the Dsco database as a result of an integration or process importing new items.  If the pageCount does change the developer should do one of the following...
    1. Enter an error condition and schedule the process to execute again at some point in the future
    2. Wait a period of time, perhaps 30 minutes, and execute the process again without creating an error condition.
  • dscoInvoiceId
    Find the Invoice with this dscoInvoiceId (the DSCO created unique ID for the invoice).
  • invoiceId
    Find the Invoice with  this invoiceId (the supplier created unique ID for the invoice).
  • poNumber
    Find the Invoice associated with the order that has this poNumber.
  • sellerInvoiceNumber
    Find the Invoice with the this sellerInvoiceNumber.
  • supplierOrderNumber
    Find the Invoice with the this supplierOrderNumber.
  • consumerOrderNumber
    Find the Invoice with the this consumerOrderNumber.
  • invoicesCreatedInLast
    Find Invoices created within the last xyz seconds.  The maximum value allowed is one year ago (31536000). This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • invoicesUpdatedInLast
    Find Invoices updated within the last xyz seconds.  The maximum value allowed is one year ago (31536000). This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • invoicesCreatedSince
    Find Invoices created since this ISO 8601 date (e.g. 2014-01-01T10:30:00+01:00).  The maximum value allowed is one year in the past. This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • invoicesUpdatedSince
    Find Invoices updated since this ISO 8601 date (e.g. 2014-01-01T10:30:00+01:00). The maximum value allowed is one year in the past. This value is inclusive in that the search looks for objects greater than or equal to the time specified.
  • until
    Find invoices created/updated up until this ISO 8601 date (e.g. 2014-01-01T10:30:00+01:00). This param will be ignored unless one of the period-based params is included (invoicesCreatedInLast, invoicesUpdatedInLast, invoicesCreatedSince, invoicesUpdatedSince). This value is exclusive in that the search looks for objects right up to but not including the very moment requested, e.g. searching until 10:30:00 finds objects up until 10:29:59.999)

 Output Object

The result of calling this API is the PagedInvoiceResult JSON Object. It will contain the list of invoices returned from this API for the specified page of results if any.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.