POST BudgetBilling/PostBudgetBillingInvoice

Creates a new Budget Billing Invoice.

Request Information

URI Parameters

Body Parameters

Budget Billing Invoice object used to create the transaction.

ClsMemoInvoiceApiAdd
NameDescriptionTypeAdditional Information
TankIdentifier

The LPTank identifier for this Memo Invoice - Either the GUID or the SN must be provided. Guid will be used if populated. This must be for a tank that is setup as a budget billing tank with an EQCycle.

ClsLpTankIdentifier

Required

LocationIdentifier

The location identifier for this Memo Invoice - Either the GUID or the ID must be provided. Guid will be used if populated.

ClsLocationIdentifier

Required

InvoiceDate

The Date for the Memo Invoice.

string

Required

Format must be MM/dd/yyyy

DueDate

The Due Date for the Memo Invoice. Must be on or after the InvoiceDate.

string

Required

Format must be MM/dd/yyyy

Request Formats

application/json, text/json

Sample:
{
  "TankIdentifier": {
    "TankGuid": "9a1754ea-e486-44ec-8781-3caa9033771a",
    "SerialNumber": "sample string 1"
  },
  "LocationIdentifier": {
    "LocationGUID": "d9627b93-106b-4a04-900c-8e52e89fa151",
    "LocationID": "sample string 1"
  },
  "InvoiceDate": "sample string 4",
  "DueDate": "sample string 5"
}

application/xml, text/xml

Sample:
<clsMemoinvoice.ClsMemoInvoiceApiAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AR">
  <DueDate>sample string 5</DueDate>
  <InvoiceDate>sample string 4</InvoiceDate>
  <LocationIdentifier xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Location">
    <d2p1:LocationGUID>d9627b93-106b-4a04-900c-8e52e89fa151</d2p1:LocationGUID>
    <d2p1:LocationID>sample string 1</d2p1:LocationID>
  </LocationIdentifier>
  <TankIdentifier>
    <SerialNumber>sample string 1</SerialNumber>
    <TankGuid>9a1754ea-e486-44ec-8781-3caa9033771a</TankGuid>
  </TankIdentifier>
</clsMemoinvoice.ClsMemoInvoiceApiAdd>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsMemoInvoiceApiAdd'.

Response Information

Resource Description

Creates a new Budget Billing Invoice.

AgvBudgetBilling
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of errors from the API

Collection of string
WarningList

List of warnings from the API

Collection of string
Count

Number of results returned

string
Data

List of properties and values returned for each Budget Billing Invoice that matches the request

Collection of ClsMemoInvoiceApiItem

Will be "null" when the status is not success.

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Data": [
    {
      "MemoInvoiceGuid": "f4a7b7e8-67a9-464d-bd5d-c40753a7c401",
      "InvNum": 1,
      "Location": "sample string 2",
      "InvDate": "sample string 3"
    },
    {
      "MemoInvoiceGuid": "f4a7b7e8-67a9-464d-bd5d-c40753a7c401",
      "InvNum": 1,
      "Location": "sample string 2",
      "InvDate": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvBudgetBilling xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.MemoInvoice">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsMemoinvoice.ClsMemoInvoiceApiItem>
      <d2p1:InvDate>sample string 3</d2p1:InvDate>
      <d2p1:InvNum>1</d2p1:InvNum>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:MemoInvoiceGuid>f4a7b7e8-67a9-464d-bd5d-c40753a7c401</d2p1:MemoInvoiceGuid>
    </d2p1:clsMemoinvoice.ClsMemoInvoiceApiItem>
    <d2p1:clsMemoinvoice.ClsMemoInvoiceApiItem>
      <d2p1:InvDate>sample string 3</d2p1:InvDate>
      <d2p1:InvNum>1</d2p1:InvNum>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:MemoInvoiceGuid>f4a7b7e8-67a9-464d-bd5d-c40753a7c401</d2p1:MemoInvoiceGuid>
    </d2p1:clsMemoinvoice.ClsMemoInvoiceApiItem>
  </Data>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBudgetBilling>