Invoice

The Invoice object

An invoice essentially consists of

  • An invoice address and contact person
  • Items (the rows on the invoice)
  • State (draft, finished, canceled etc)
  • References to jobs, reports etc to maintain traceability

Example

Example invoice

The invoice in the screenshot above would look like this in its JSON representation: 


			


			

				
States

				

                    An invoice can have the following states:
                    DRAFT, INCOMPLETE, PENDING, QUEUED, SENT, FINISHED, CANCELED, ERROR.
				

                

                    The following states are not user-selectable and should only arise as a result of integrations with external invoicing systems:
                    INCOMPLETE, QUEUED, SENT, ERROR
                

                

                    Integrations react to the state PENDING, queue the invoice for processing and update the state to QUEUED.
			

		


		

			
Get invoice history

			

				

					

						

							Get a list of previously saved invoices.
                            The list is ordered by descending invoiceDate.
						


						
Query Parameters

						

							

								
									from
								
								
									List invoices from this date/time
								
								
									Timestamp
								
								
									2017-01-01
								
							

							

								
									to
								
								
									List up to this date/time
								
								
									Timestamp
								
								
									2017-01-05
								
							

							

								
									limit
								
								
									Limit the number of returned objects
								
								
									Integer
								
							

							

								
									offset
								
								
									Skip the first N objects
								
								
									Integer
								
							

							

								
									modified
								
								
									Include only objects modified since this date/timestamp
								
								
									Timestamp
								
								
									2015-10-05
								
							

						


						

							
Example

							
GET /invoice/history


							
Response

                            

                                A list of invoice objects.
                            


						


					

				

				

					

						

							
Method

							
GET

							
URL

							
/invoice/history

							
Authentication

							
Token

							
Response

							
List of Invoice objects

						

					

				
 
			

		


		

			
Get an invoice

			

				

					

						

							Get a specific invoice by ID or UUID.
						


						

							
Example

							
GET /invoice/2039077


							
Response

                            

                                An invoice object.
                            


						


					

				

				

					

						

							
Method

							
GET

							
URL

							
/invoice/:id

							
Authentication

							
Token

							
Response

							
Invoice object