# Invoice

## Retrieves the collection of Invoice resources.

> Retrieves the collection of Invoice resources.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Invoice.InvoiceDTO.jsonld-invoice.read_address.read_translation":{"type":"object","description":"Invoice","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier","type":"integer"},"number":{"type":"integer"},"date":{"type":"string","format":"date-time","nullable":true},"state":{"$ref":"#/components/schemas/InvoiceState","type":"string"},"orderNumber":{"type":"string"},"internalDepartment":{"type":"string"},"internalCostcenter":{"type":"string"},"reverseChargeState":{"$ref":"#/components/schemas/ReverseChargeState","type":"string"},"additionalText":{"type":"string"},"frame":{"type":"string","format":"iri-reference"},"responsiblePerson":{"description":"Person that is responsible for this invoice","type":"string","format":"iri-reference"},"paymentMethod":{"description":"Link to payment method","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The address used within the invoice","$ref":"#/components/schemas/AddressDTO.jsonld-invoice.read_address.read_translation"},"shippingAddress":{"description":"The shipping address used within the invoice","anyOf":[{"$ref":"#/components/schemas/AddressDTO.jsonld-invoice.read_address.read_translation"}],"nullable":true},"versions":{"type":"array","items":{"type":"string","format":"iri-reference"}}}},"InvoiceState":{"type":"string","enum":["booked","canceled"]},"ReverseChargeState":{"type":"string","enum":["none","eu","foreign"]},"AddressDTO.jsonld-invoice.read_address.read_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}},"Invoice.InvoiceDTO-invoice.read_address.read_translation":{"type":"object","description":"Invoice","properties":{"id":{"description":"The unique identifier","type":"integer"},"number":{"type":"integer"},"date":{"type":"string","format":"date-time","nullable":true},"state":{"$ref":"#/components/schemas/InvoiceState","type":"string"},"orderNumber":{"type":"string"},"internalDepartment":{"type":"string"},"internalCostcenter":{"type":"string"},"reverseChargeState":{"$ref":"#/components/schemas/ReverseChargeState","type":"string"},"additionalText":{"type":"string"},"frame":{"type":"string","format":"iri-reference"},"responsiblePerson":{"description":"Person that is responsible for this invoice","type":"string","format":"iri-reference"},"paymentMethod":{"description":"Link to payment method","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The address used within the invoice","$ref":"#/components/schemas/AddressDTO-invoice.read_address.read_translation"},"shippingAddress":{"description":"The shipping address used within the invoice","anyOf":[{"$ref":"#/components/schemas/AddressDTO-invoice.read_address.read_translation"}],"nullable":true},"versions":{"type":"array","items":{"type":"string","format":"iri-reference"}}}},"AddressDTO-invoice.read_address.read_translation":{"type":"object","description":"","properties":{"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}}}},"paths":{"/api/invoices":{"get":{"operationId":"getInvoiceCollection","tags":["Invoice"],"responses":{"200":{"description":"Invoice collection","content":{"application/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#/components/schemas/Invoice.InvoiceDTO.jsonld-invoice.read_address.read_translation"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text/html":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Invoice.InvoiceDTO-invoice.read_address.read_translation"}}}}}},"summary":"Retrieves the collection of Invoice resources.","description":"Retrieves the collection of Invoice resources.","parameters":[{"name":"id[between]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Retrieves a Invoice resource.

> Retrieves a Invoice resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Invoice.InvoiceDTO.jsonld-invoice.read_address.read_translation":{"type":"object","description":"Invoice","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"description":"The unique identifier","type":"integer"},"number":{"type":"integer"},"date":{"type":"string","format":"date-time","nullable":true},"state":{"$ref":"#/components/schemas/InvoiceState","type":"string"},"orderNumber":{"type":"string"},"internalDepartment":{"type":"string"},"internalCostcenter":{"type":"string"},"reverseChargeState":{"$ref":"#/components/schemas/ReverseChargeState","type":"string"},"additionalText":{"type":"string"},"frame":{"type":"string","format":"iri-reference"},"responsiblePerson":{"description":"Person that is responsible for this invoice","type":"string","format":"iri-reference"},"paymentMethod":{"description":"Link to payment method","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The address used within the invoice","$ref":"#/components/schemas/AddressDTO.jsonld-invoice.read_address.read_translation"},"shippingAddress":{"description":"The shipping address used within the invoice","anyOf":[{"$ref":"#/components/schemas/AddressDTO.jsonld-invoice.read_address.read_translation"}],"nullable":true},"versions":{"type":"array","items":{"type":"string","format":"iri-reference"}}}},"InvoiceState":{"type":"string","enum":["booked","canceled"]},"ReverseChargeState":{"type":"string","enum":["none","eu","foreign"]},"AddressDTO.jsonld-invoice.read_address.read_translation":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}},"Invoice.InvoiceDTO-invoice.read_address.read_translation":{"type":"object","description":"Invoice","properties":{"id":{"description":"The unique identifier","type":"integer"},"number":{"type":"integer"},"date":{"type":"string","format":"date-time","nullable":true},"state":{"$ref":"#/components/schemas/InvoiceState","type":"string"},"orderNumber":{"type":"string"},"internalDepartment":{"type":"string"},"internalCostcenter":{"type":"string"},"reverseChargeState":{"$ref":"#/components/schemas/ReverseChargeState","type":"string"},"additionalText":{"type":"string"},"frame":{"type":"string","format":"iri-reference"},"responsiblePerson":{"description":"Person that is responsible for this invoice","type":"string","format":"iri-reference"},"paymentMethod":{"description":"Link to payment method","type":"string","format":"iri-reference","nullable":true},"address":{"description":"The address used within the invoice","$ref":"#/components/schemas/AddressDTO-invoice.read_address.read_translation"},"shippingAddress":{"description":"The shipping address used within the invoice","anyOf":[{"$ref":"#/components/schemas/AddressDTO-invoice.read_address.read_translation"}],"nullable":true},"versions":{"type":"array","items":{"type":"string","format":"iri-reference"}}}},"AddressDTO-invoice.read_address.read_translation":{"type":"object","description":"","properties":{"id":{"description":"The unique identifier for the address","type":"integer"},"street":{"description":"The street","type":"string"},"zip":{"description":"The zip code","type":"string"},"city":{"description":"The city","type":"string"},"phone":{"description":"The phone number","type":"string"},"mobilePhone":{"description":"The mobile phone number","type":"string"},"fax":{"description":"The fax number","type":"string"},"company":{"description":"The company","type":"string"},"department":{"description":"The department","type":"string"},"aux":{"description":"The aux","type":"string"},"state":{"description":"The state","type":"string"},"country":{"description":"The country","type":"string"},"email":{"description":"The mail address","type":"string"},"careOf":{"description":"The careOf addition","type":"string"},"url":{"description":"The url","type":"string"},"vatId":{"description":"The vat","type":"string"}}}}},"paths":{"/api/invoices/{id}":{"get":{"operationId":"getInvoiceItem","tags":["Invoice"],"responses":{"200":{"description":"Invoice resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Invoice.InvoiceDTO.jsonld-invoice.read_address.read_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Invoice.InvoiceDTO-invoice.read_address.read_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Invoice resource.","description":"Retrieves a Invoice resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```