Registrar Web Services

<back to all web services

R_Invoices

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Invoices
GET,OPTIONS/R_Invoices/{Ids}
GET,OPTIONS/R_Invoices/SubscriptionIds/{SubscriptionIds}
GET,OPTIONS/R_Invoices/InvoiceIds/{InvoiceIds}
GET, OPTIONS/R_Invoices/StartDate/{StartChargeOnDateTicks}/EndDate/{EndChargeOnDateTicks}
GET, OPTIONS/R_Invoices/PaidDate/Start/{StartPaidOnDateTicks}/End/{EndPaidOnDateTicks}
R_Invoices Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdspathList<long>No
InvoiceIdspathList<long>No
AccountHolderIdsqueryList<long>No
IdspathList<long>No
StartChargeOnDateTickspathlong?No
EndChargeOnDateTickspathlong?No
StartPaidOnDateTickspathlong?No
EndPaidOnDateTickspathlong?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/reply/R_Invoices HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_Invoices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <AccountHolderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountHolderIds>
  <EndChargeOnDateTicks>0</EndChargeOnDateTicks>
  <EndPaidOnDateTicks>0</EndPaidOnDateTicks>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <InvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </InvoiceIds>
  <StartChargeOnDateTicks>0</StartChargeOnDateTicks>
  <StartPaidOnDateTicks>0</StartPaidOnDateTicks>
  <SubscriptionIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </SubscriptionIds>
</R_Invoices>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Invoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Invoice>
    <ChargeOnDate>0001-01-01T00:00:00</ChargeOnDate>
    <ChargedOnDate>0001-01-01T00:00:00</ChargedOnDate>
    <Cleared>false</Cleared>
    <CreateDate>0001-01-01T00:00:00</CreateDate>
    <Description>String</Description>
    <DunningLevelId>0</DunningLevelId>
    <Id>0</Id>
    <InvoiceStatusTypeId>0</InvoiceStatusTypeId>
    <NotificationDate>0001-01-01T00:00:00</NotificationDate>
    <PaidDate>0001-01-01T00:00:00</PaidDate>
    <ServiceEndDate>0001-01-01T00:00:00</ServiceEndDate>
    <ServiceStartDate>0001-01-01T00:00:00</ServiceStartDate>
    <SubscriptionId>0</SubscriptionId>
  </R_Invoice>
</ArrayOfR_Invoice>