GET https://api.adsalesgenius.com/invoices/
Request Parameters
Paramater Description Required Default Data Type
advertiser_id Reference to advertiser object. No Integer
amount_from No Double
amount_to No Double
contract_id Reference to contract object. No Integer
date_created_after No Date
date_created_before No Date
date_due_after No Date
date_due_before No Date
page Page of results to return No 1 Integer
per_page Number of items to return per page (100 Max) No 25 Integer
sort_by ('id','date_created','date_due','total') No id Enum
sort_order asc or desc No desc Enum
Response Parameters
Parameter Description Data Type
billing_address Address object. Address Object
billing_email Contact Data object Contact Data Object
comments String
currency.id Reference to currency object. Integer
currency.name String
date_created Date
date_deleted Date
date_due Date
date_modified Date
discount_amount Double
discount_total String
exchange_rate Multiplier for conversion of currency from home currency. Double
id Unique id of payment object. Integer
line_items.amount Double
line_items.contract_line_item_id Reference to contract line item object. Integer
line_items.delivery_log_id Reference to delivery log object. Integer
line_items.description String
line_items.id Unique id of invoice line item object. Integer
line_items.insertion_id Reference to insertion object. Integer
line_items.invoice_id Reference to invoice object. Integer
line_items.invoice_line_item_type_id Reference to invoice line item type object. Integer
line_items.taxable Bool
line_items.total Double
status 'Paid','Unpaid' String
sub_total String
tax_after_discount If discount is calculated pre or post tax. Bool
tax_percent_based Bool
tax_rate Double
tax_total Double
total Double
Example Response
{
  "invoices":[
    {
      "id":"5717",
      "contract_id":"100",
      "advertiser_id":"691",
      "billing_address":null,
      "billing_email":null,
      "tax_rate":null,
      "tax_after_discount":null,
      "tax_percent_based":null,
      "discount_amount":null,
      "currency":null,
      "sub_total":"0",
      "discount_total":"0",
      "tax_total":"0",
      "total":"0",
      "status":"Paid",
      "date_due":"2009-01-16 00:00:00",
      "exchange_rate":null,
      "comments":null,
      "date_created":"2009-01-16 00:00:00",
      "date_deleted":null,
      "date_modified":null,
      "line_items":[
        {
          "id":"145128",
          "invoice_id":"5717",
          "taxable":false,
          "amount":"0",
          "total":"0",
          "description":null,
          "invoice_line_item_type_id":null,
          "insertion_id":"253",
          "delivery_log_id":null,
          "contract_line_item_id":null
        }
      ]
    },
    {
      "id":"5716",
      "contract_id":"100",
      "advertiser_id":"691",
      "billing_address":null,
      "billing_email":null,
      "tax_rate":null,
      "tax_after_discount":null,
      "tax_percent_based":null,
      "discount_amount":null,
      "currency":null,
      "sub_total":"0",
      "discount_total":"0",
      "tax_total":"0",
      "total":"0",
      "status":"Paid",
      "date_due":"2009-01-16 00:00:00",
      "exchange_rate":null,
      "comments":null,
      "date_created":"2009-01-16 00:00:00",
      "date_deleted":null,
      "date_modified":null,
      "line_items":[
        {
          "id":"145127",
          "invoice_id":"5716",
          "taxable":false,
          "amount":"0",
          "total":"0",
          "description":null,
          "invoice_line_item_type_id":null,
          "insertion_id":"252",
          "delivery_log_id":null,
          "contract_line_item_id":null
        }
      ]
    },
    {
      "id":"5715",
      "contract_id":"100",
      "advertiser_id":"691",
      "billing_address":null,
      "billing_email":null,
      "tax_rate":null,
      "tax_after_discount":null,
      "tax_percent_based":null,
      "discount_amount":null,
      "currency":null,
      "sub_total":"2982",
      "discount_total":"0",
      "tax_total":"0",
      "total":"2982",
      "status":"Paid",
      "date_due":"2009-01-16 00:00:00",
      "exchange_rate":null,
      "comments":null,
      "date_created":"2009-01-16 00:00:00",
      "date_deleted":null,
      "date_modified":null,
      "line_items":[
        {
          "id":"145126",
          "invoice_id":"5715",
          "taxable":false,
          "amount":"2982",
          "total":"2982",
          "description":null,
          "invoice_line_item_type_id":null,
          "insertion_id":"251",
          "delivery_log_id":null,
          "contract_line_item_id":null
        }
      ]
    }
  ]
}