Table of Contents
The pay/getBilling method is an Elance Developer API Pay method that returns a billing object for the supplied invoice ID.
A billing instance consists of an invoice (InvoiceData object), an array of invoice details (InvoiceDetailsData object), a log of associated invoicing activity (InvoiceActivityData object), and an array detailing the payments made by the client to the provider (PaymentData object). Billing IDs are obtained from one of two sources:
- The invoiceId parameter of the TimesheetData object, which is returned by the API methods pay/getTimesheetsForBid and pay/getTimesheet.
- The invoiceIds array of the StatusReportData object, which is returned by the API methods pay/getStatusReportsForBid and pay/getStatusReport.
pay/getBilling is an authenticated method. It requires a Developer API key and an OAuth Consumer Secret, both issued by Elance. It is invoked using an HTTP or HTTPS GET request. For more details on the OAuth authentication protocol, see Using OAuth with Authenticated Methods.
This method does not support the JSONP response format.
For more information on the format of an Elance Developer API request, see Getting Started.
I. Required Query String Parameters
|id||integer||The unique ID, assigned by Elance, to the requested billing object. This is the invoiceId property returned by methods such as pay/getStatusReportsForBid, pay/getTimesheetsForBid, pay/getStatusReport, and pay/getTimesheet.|
II. Response Data Description
|bidDetails||BidData object||The details regarding this bid and associated Workroom, including project name, client, and provider.|
|invoice||InvoiceData object||Basic information about the invoice, including the amount and the currency used.|
|invoiceDetails||array of InvoiceDetailsData object||A billable instance of work activity. Includes the rate, hours, and amount billed.|
|invoiceActivity||array of InvoiceActivityData objects||A record of all payments made against this invoice. Includes associated comments for the payment, and (if applicable) a paymentId parameter that refers to a PaymentData object.|
|payments||array of PaymentData objects||A record of the actual physical payment made by the client to the provider.|