Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 2.0!

invoice object

Properties of the invoice object

{
  "id": "guid",
  "customerid": "guid",
  "subscriptionid": "guid",
  "currencycode": "string",
  "totalamount": "float",
  "total": "float",
  "totalvat": "float",
  "invoicedate": "datetime",
  "duedate": "datetime",
  "paymentdate": "datetime",
    /* 
    1024=failed,90=pendingretry,80=declined,70=pendingresponse,60=pendingpayment,
    50=cancelled,20=paid,0=notpaid,100=dunning
    */
  "paymentstatus": "integer",
    /* 
    1024=failed,0=draft,10=booked,50=cancelled 
    */
  "invoicestatus": "integer",
  /* if a paymentmethodid is associated with the invoice */
  "paymentmethodid": "integer",
  /* text representation of the payment method */
  "paymentdescriptor" : "string",
  /* text representation of the invoice (example INV-0002130) */
  "invoicenumber": "string",
  /* numeric of the invoice number (example 2130) */
  "invoicenumeric" : "integer",
  "subscription": "subscription",
  "customer": "customer",
  "invoicelines": "invoicelines[]",
  "dunningschemeid": "guid",
  "dunningscheme": "dunningscheme",
  "dunningstep": "integer",
  /* set by Upodi - external ERP id */
  "externalfinance" : "string",
  /* normal=0, draft=1, booked=2, failedbook=1024 */
  "externalstatecode" : "integer",
  /* used for integration, cam be set to a custom value */
  "refkey" : "string",
  "nextretry": "datetime",
  "createdby": "guid",
  "modifiedby": "guid",
  "createdbyuser": "userprofile",
  "modifiedbyuser": "userprofile",
  "createddate": "datetime",
  "modifieddate": "datetime"
}