# Invoice

Endpoint to retrieve data for invoices.

## Finds Invoices by filtering a specific conference(frame).

> Gets \`Invoice\` objects.

```json
{"openapi":"3.1.1","info":{"title":"Converia API","version":"2.15.0"},"tags":[{"name":"Invoice","description":"Endpoint to retrieve data for invoices."}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Api key has to be used to authenticate against the server. The token parameter has must be sent in the header","type":"apiKey","name":"token","in":"header"}},"schemas":{"Invoice":{"type":"object","description":"Represents the Invoice Entity in Converia.","required":["id","number","date","sum","currency","careOf","state","versions"],"properties":{"id":{"type":"integer","description":"The primary key of the invoice entity in Converia."},"number":{"type":"integer","description":"Conference specific identifier for the invoice."},"date":{"type":"string","format":"ISO-8601","description":"The date on which the invoice was created."},"sum":{"type":"number","description":"The total sum of the invoice."},"currency":{"type":"string","description":"The currency to which the invoice relates (i.e. `EUR`, `EURO`, `€`, `USD` or `$`).","maxLength":10},"careOf":{"type":"string","description":"Name of the person this invoice should be delivered to."},"state":{"type":"integer","enum":["0","1","5","8","10","15","40"],"description":"The current state of the invoice:\n * `0, 1, 5 or 8` - unfinished\n * `10` - valid\n * `15` - error\n * `40` - canceled"},"versions":{"type":"integer","description":"The number of existing versions.","minimum":1},"invoiceVersions":{"type":"array","description":"Array of all invoice versions, except cancellations.","items":{"$ref":"#/components/schemas/InvoiceVersion"}}}},"InvoiceVersion":{"type":"object","description":"Represents a specific version of an invoice.","properties":{"version":{"type":"integer","description":"The displayed version number for this specific invoice version."},"invoiceLog":{"type":"array","description":"Additional information about this specific invoice version. Canceled items are excluded.","items":{"$ref":"#/components/schemas/InvoiceLog"}}}},"InvoiceLog":{"type":"object","description":"Represents additional information about a specific invoice version.","properties":{"name":{"type":"string","description":"The name of the purchased item."},"amount":{"type":"number","description":"The invoice amount."},"taxRate":{"type":"number","description":"The tax rate of the invoice."},"priceGroup":{"type":"string","description":"The name of the related price group."},"category":{"type":"string","description":"The name of the related category."}}},"ErrorResult":{"type":"object","description":"Result format in an error case.","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","description":"Format of an error.","required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/rest-api/v2/frame/{id}/invoice/":{"get":{"tags":["Invoice"],"description":"Gets `Invoice` objects.","summary":"Finds Invoices by filtering a specific conference(frame).","parameters":[{"schema":{"type":"integer","format":"int64"},"name":"id","in":"path","description":"Id of the conference the invoices are loaded for.","required":true},{"schema":{"type":"array","items":{"type":"string","enum":["valid","canceled","error","unfinished"]}},"style":"form","explode":false,"name":"states","in":"query","description":"Filter for specific invoice states.","required":false},{"schema":{"type":"array","items":{"type":"string","enum":["versions"]}},"style":"form","explode":false,"name":"include","in":"query","description":"Comma separated list of related or additional data that should be fetched as well.","required":false}],"responses":{"200":{"description":"Successful response","headers":{"X-Rate-Limit-Interval":{"schema":{"type":"integer"},"description":"Interval of a time window in seconds"},"X-Rate-Limit-Reset":{"schema":{"type":"integer"},"description":"The remaining window before the credit limit resets in seconds"},"X-Rate-Limit-Remaining":{"schema":{"type":"integer"},"description":"The number of credits left for the time window"},"X-Rate-Limit-Limit":{"schema":{"type":"integer"},"description":"Credit limit per time window"}},"content":{"application/json":{"schema":{"title":"Result Record","type":"object","required":["data"],"properties":{"meta":{"type":"object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Authentication problem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"No resource found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"429":{"description":"Rate limitation exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}}}
```