invoice.getdetails function

Home > accounting > func.invoice.getdetails

function invoice.getdetails

page under construction

Fetches the details of an invoice.

Arguments:

arg	required?	syntax	info
`invoiceID`	Y	posint	invoiceID of invoice, as returned by `invoice.create` or `invoice.list`
`custID`	N	posint	custID of account that the invoice was raised on (default is your own account)
`formatted`	N	boolean	if evaluates to true, an additional "formatted" array element is returned; this which contains formatted invoice layouts ready for output

Example

Perl example request:

POST https://live.apicontrol.co.uk/1/json
my $api = new CCclient($u, $p, $live); # this must be logging in to the parent account of the one being invoiced
my $items =
  [
    {
      'price' =>'3.23',
      'text' => 'Some bits',
    },
    {
      'price'=>'9.95',
      'domain'=>'mystuff.com',
      'datefrom'=>'2009-01-01',
      'dateto'=>'2009-12-31'
    },
  ];

my %invargs =
  (
    'invoicerID' => $api->custID,
    'custID' => 16526,
    'invoicer_company' => 'skycom',
    'ignore_credit_limit' => 1,
    'items' => $items,
    'address' =>
      {
        'contactname' => 'Mr Test',
        'companyname' => 'Tinkly Ltd',
        'addr1' => '81 Fothering Street',
        'addr2' => 'Tinkleton',
        'postcode' => 'N1 8QT',
        'email'=>'mrtest@mailme.tickles.org',
      },
  );


my $res = $api->invoice_create(%invargs);

XML example request:

POST https://live.apicontrol.co.uk/1/json

The response includes the following information:

invoiceID - the internal ID of the invoice. You may need this for other functions (such as payment.assign). THIS IS NOT THE INVOICE NUMBER.
invnum - the invoice number.
subtotal - the total of the invoice or credit note, net of VAT
vat - the VAT charge
total - the total amount payable, ie subtotal + vat
payment_due - the date that full payment is due by
oldbalancepence - the customer account balance, in pence, prior to this invoice/credit note being raised

Perl example response:

{
  'success' => '1',
  'vat' => '1.97',
  'payment_due' => '2009-07-20',
  'subtotal' => '13.18',
  'total' => '15.15',
  'errordiags' => '',
  'textID' => '201046',
  'invnum' => '127762',
  'error' => undef,
  'invoiceID' => '108239',
  'errornum' => '',
  'seq' => '34',
  'oldbalancepence' => '-2006',
  'results' => []
};

XML example response:

** page under construction **

Arguments:

Example

page under construction