API fields documentation

Self-Hosted | v4/Legacy
1

Hi!
I’m testing the API but I can’t find anywhere information about the fields needed.
I can see which fields I can use from the response I receive from the server, but I don’t know which value I can use.
For example what are the values that I could use for these fields and what are the meanings?

  • “invoice_status_id”
  • “invoice_type_id”
  • “invoice_item_type_id”

If there would be a list of all the fields that would be GREAT!
Thanks,
Andrea

2

I’d suggest referencing the database for the list of all fields.

Note: invoice_status_id is read-only

https://github.com/invoiceninja/invoiceninja/blob/master/app/Constants.php#L191
https://github.com/invoiceninja/invoiceninja/blob/master/app/Constants.php#L45
https://github.com/invoiceninja/invoiceninja/blob/master/app/Constants.php#L48

3

Thanks, but even with those fields, I can’t know which value I could assign to each.
For example, how can I mark an invoice as paid within the creation and how can I modify that field if the invoice already exists?
Thanks a lot for your time!
Andrea

4

When creating an invoice you can set the ‘paid’ field to the total amount to mark the invoice as paid.

http://docs.invoiceninja.com/en/latest/api.html#options

Otherwise, create a payment to mark the invoice as paid.

5

Thanks!