<back to all web services
R_InvoiceSummary
Requires Authentication
| Required role: | Admin |
The following routes are available for this service:| OPTIONS | /R_InvoiceSummary | | |
|---|
R_InvoiceSummary Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Id | query | long | No | |
| Invoice | query | R_Invoice | No | |
| LineItems | query | List<R_InvoiceLineItem> | No | |
R_Invoice Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Description | form | string | No | |
| SubscriptionId | form | long | No | |
| InvoiceStatusTypeId | form | long | No | |
| CreateDate | form | DateTime | No | |
| ChargeOnDate | form | DateTime | No | |
| NotificationDate | form | DateTime? | No | |
| PaidDate | form | DateTime? | No | |
| ChargedOnDate | form | DateTime? | No | |
| ServiceStartDate | form | DateTime | No | |
| ServiceEndDate | form | DateTime | No | |
| Cleared | form | bool | No | |
| DunningLevelId | form | long | No | |
| Id | form | long | No | |
R_InvoiceLineItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Id | form | long | No | |
| Description | form | string | No | |
| InvoiceId | form | long | No | |
| PriceId | form | long | No | |
| Amount | form | decimal | No | |
| CurrencyTypeId | form | long | No | |
| UnitId | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /xml/oneway/R_InvoiceSummary HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: application/xml
Content-Length: length
<R_InvoiceSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
<Id>0</Id>
<Invoice xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
<d2p1:ChargeOnDate>0001-01-01T00:00:00</d2p1:ChargeOnDate>
<d2p1:ChargedOnDate>0001-01-01T00:00:00</d2p1:ChargedOnDate>
<d2p1:Cleared>false</d2p1:Cleared>
<d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
<d2p1:Description>String</d2p1:Description>
<d2p1:DunningLevelId>0</d2p1:DunningLevelId>
<d2p1:Id>0</d2p1:Id>
<d2p1:InvoiceStatusTypeId>0</d2p1:InvoiceStatusTypeId>
<d2p1:NotificationDate>0001-01-01T00:00:00</d2p1:NotificationDate>
<d2p1:PaidDate>0001-01-01T00:00:00</d2p1:PaidDate>
<d2p1:ServiceEndDate>0001-01-01T00:00:00</d2p1:ServiceEndDate>
<d2p1:ServiceStartDate>0001-01-01T00:00:00</d2p1:ServiceStartDate>
<d2p1:SubscriptionId>0</d2p1:SubscriptionId>
</Invoice>
<LineItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
<d2p1:R_InvoiceLineItem>
<d2p1:Amount>0</d2p1:Amount>
<d2p1:CurrencyTypeId>0</d2p1:CurrencyTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:InvoiceId>0</d2p1:InvoiceId>
<d2p1:PriceId>0</d2p1:PriceId>
<d2p1:UnitId>String</d2p1:UnitId>
</d2p1:R_InvoiceLineItem>
</LineItems>
</R_InvoiceSummary>