GET Invoice/GetInvoiceListByCustomerIDByPaidStatus?CustomerID={CustomerID}&PaidStatus={PaidStatus}

Returns invoice data.

Request Information

URI Parameters

Name	Description	Type	Additional Information
CustomerID	Customer ID to return invoices for.	string	Required
PaidStatus	Paid to only return invoices that are fully paid. Default is paid, not paid, and partially paid.	string	Required

Body Parameters

Response Information

Resource Description

Returns invoice data.

AgvInvoice

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many Invoices.	string
InvoiceRecords	JSON dictionary of InvoiceRecords.	Collection of clsAPIInvoice

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "InvoiceRecords": [
    {
      "InvoiceDate": "sample string 1",
      "InvoiceLocation": "sample string 2",
      "InvoiceNumber": "sample string 3",
      "InvoiceRecordHeaderDetails": null,
      "InvoiceRecordSplitDetails": [],
      "InvoiceRecordLineItemDetails": [],
      "InvoiceTaxCodeDetails": [],
      "InvoiceBooksDetails": [],
      "InvoiceBlendsDetails": [],
      "InvoiceDelivsDetails": [],
      "InvoiceEnergyDetails": [],
      "InvoiceApplicatorDetails": []
    },
    {
      "InvoiceDate": "sample string 1",
      "InvoiceLocation": "sample string 2",
      "InvoiceNumber": "sample string 3",
      "InvoiceRecordHeaderDetails": null,
      "InvoiceRecordSplitDetails": [],
      "InvoiceRecordLineItemDetails": [],
      "InvoiceTaxCodeDetails": [],
      "InvoiceBooksDetails": [],
      "InvoiceBlendsDetails": [],
      "InvoiceDelivsDetails": [],
      "InvoiceEnergyDetails": [],
      "InvoiceApplicatorDetails": []
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.