Back to index

FOREST CRM - CSV Invoice API

This API provides access to invoice data in the ForestCRM system.

This API provides the following services:

List invoices

Request

The request format is:

https://app.forestcrm.hu/api/csv/<API KEY>/invoices

Request HTTP method: GET

Request parameters:

companyId (optional):
id of the company whose invoices are queried.
opportunityId (optional):
id of the opportunity whose invoices are queried.
invoiceNo (optional):
The 'invoice number' (external identifier) of the invoice(s) to be fetched.

If no parameters are supplied, all invoices for the tenant are returned. Any combination of parameters are allowed; they are 'AND'-ed.

Example

GET https://app.forestcrm.hu/api/csv/demo/invoices?companyId=35927

Response

Response has the following columns:

  1. invoice_id
  2. opportunity_id
  3. company_id
  4. Invoice no
  5. Description
  6. Amount
  7. Currency
  8. Delivery date
  9. Invoice date
  10. Due date
  11. Paid date
  12. Created at
  13. Updated at
  14. External ref

Example

invoice_id opportunity_id company_id Invoice no Description Amount Currency Delivery date Invoice date Due date Paid date Created at Updated at External ref
843 13875 35927 inv-1234 Rollup 500 EUR 2013-04-04 2013-04-30 2013-05-04 2013-04-30 16:21:22 +0200 2013-04-30 16:21:22 +0200

Back to index