Billing View

From INAP Dropzone API
Jump to: navigation, search

The billing view command displays details of an invoice from SingleHop.

Contents

Path

  • /billing/view/{$invoiceid}

Method

Required Data Parameters

  • {$invoiceid}

Optional Data Parameters

  • none

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
    [services] => Array(
      [0] => stdClass Object(
        [id] => The ID of the item being invoiced, different from the service ID.
        [serviceid] => The service ID of item being invoiced.
        [due] => The due date of item being invoiced.
        [description] => The description of the item being invoiced.
        [period] => Invoiced item pay period.
        [quantity] => The quantity of items being invoiced.
        [discount] => The discount that is applied to the item being invoiced as a percentage.
        [cost] => The cost of item being invoiced (cost * quantity).
        [price] => The price of item being invoiced.
        [unpaid] => The amount that is currently unpaid for the item being invoiced.
        [paid] => The amount that has been paid for the item being invoiced.
      )
    )
    [details] => stdClass Object(
      [id_number] => The ID of the invoice.
      [clientid] => The LEAP customer ID.
      [date] => The date the invoice was generated.
      [due] => The due date of the invoice.
      [client] => stdClass Object(
        [first] => Clients first name.
        [last] => Clients last name.
        [company] => Clients company name.
        [address] => Clients address.
        [city] => Clients city.
        [state] => Clients state.
        [zip] => Clients ZIP code.
        [country] => Clients country.
      )
      [summary] => stdClass Object(
        [invnote] => Contains SingleHop's address.
        [payments] => The number of payments applied to the invoice.
        [prior_balance] => Shows the total past due balance.
        [invoice_note] => An object containing notes about the invoice.
        [total_current_charges] => Current charges that haven't been paid yet.
        [account_balance] => Current account balance.
        [unpaid_balance] => An object containing the invoices unpaid balance.
        [current_charges] => The amount that is being charged on this invoice.
        [amount_charged] => The amount of this invoice that was paid using an external payment method.
        [account_credits] => The amount of this invoice that was paid with an account credit.
      )
      [aged] => stdClass Object (
        [aged_current] => An object containing the dollar amount of current due invoices.
        [aged_zero_thirty] => An object containing the dollar amount of overdue invoices 1-30 days.
        [aged_thirty_sixty] => An object containing the dollar amount of overdue invoices 31-60 days.
        [aged_sixty_ninety] => An object containing the dollar amount of overdue invoices 61-90 days.
        [aged_ninety_onetwenty] => An object containing the dollar amount of overdue invoices 91-120 days.
        [aged_onetwenty_plus] => An object containing the dollar amount of overdue invoices 120+ days.
      )
      [credits] => stdClass Object(
        [credit] => stdClass Object(
          [credit_id] => The ID of the credit that was applied to the invoice.
          [reason] => The reason the credit was applied to the invoice.
          [amount] => The total amount of the credit
          [date] => The date the credit was applied to the invoice.
          [value] => The amount of the credit used on the invoice.
          [comments] => Comments about the credit applied to the invoice.
        )
      )
      [taxes] => An object containing tax information for the invoice.
      [amount_unpaid] => The total amount of the invoice that hasn't been paid.
    )
  )
)
Personal tools