How to obtain a list of a user's invoices

User invoices can be retrieved by using the following URL and specifying a user ID, starting record number and ending record number.  If left blank, this will default to the first 50 records.  Invoices are returned in order of descending date.

 

 Method URL
 GET  https://api.fairwarningsoftware.com/v1.1.1/user/invoices/[user-id]/[start]/[limit]

 

 Status Response
 200

 {"invoices":
    [
        {
            "invoice": {
                "invoice_id": <invoice_id>,
                "auction_id": <auction_id>,
                "invoice_date": <invoice_date>,
                "invoice_email_date": <invoice_email_date>,
                "invoice_shipping": <invoice_shipping>,
                "invoice_hammer": <invoice_hammer>,
                "invoice_premium": <invoice_premium>,
                "invoice_paid": <invoice_paid>
            }
        }
    ],
    "record_count" : <record_count>
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type Description
invoice_id int The unique identifier for the invoice.
auction_id int The ID for the auction.
invoice_date string The date the invoice was generated.
invoice_email_date string The date the invoice was emailed to the user.
invoice_shipping string The shipping costs for the invoice.
invoice_hammer string The total hammer price for the invoice.
invoice_premium string The total premium for the invoice.
invoice_paid string Whether all items in the invoice have been paid for or not.
record_count int The total number of records matching the search results