Skip to main content

Invoice

Contains the invoicing data of a client for a single calendar month regarding the performed benefits of a given service area

type Invoice {
  area: ServiceArea!
  asBremenStatusLog: [AsBremenStatusLogEntry!]!
  canceledAt: Date
  cancellationReason: String
  careDegreeChanged: Boolean!
  careDegreeLevel: CareDegreeLevel
  client: Client!
  dtaInstruction: Document
  dtaNumber: String
  dtaPayload: Document
  dtaSheet: Document
  hints: [String!]
  id: InvoiceID!
  invoiceDocument: Document
  invoiceNumber: String
  issuedAt: Date
  month: Date!
  odooUrl: Url
  paymentCondition: String!
  pdfUrl: String
  performanceReport: DividedPerformanceReport
  positions: [InvoicePosition!]!
  recipient: MailingAddress
  recipientIK: InstitutionCode
  recipientType: InvoiceRecipientType
  reversalInvoiceNumber: String
  reversalPdfUrl: String
  sendAt: LocalDateTime
  status: InvoiceStatus!
  total: Float!
  type: InvoiceType!
}

Fields​

Invoice.area ● ServiceArea! non-null enum​

The service area, which the invoice corresponds to (e.g. SGB_V_HKP, PRIVATE, ...)

Invoice.asBremenStatusLog ● [AsBremenStatusLogEntry!]! non-null object​

List of AS Bremen Status Logs.

If AS Bremen API is disabled this will always return an empty list.

Invoice.canceledAt ● Date scalar​

(Optional) Date when this invoice was canceled.

Invoice.cancellationReason ● String scalar​

(Optional) Reason why this invoice was canceled.

Invoice.careDegreeChanged ● Boolean! non-null scalar​

Flag set to the invoices with incorrect basis, whose client's care degree level has changed

Invoice.careDegreeLevel ● CareDegreeLevel enum​

The care degree of the client used to create this invoice.

Invoice.client ● Client! non-null object​

Reference to the client, to whom the invoice belongs

Invoice.dtaInstruction ● Document object​

The DTA document containing meta information about this invoice. It's called a AUFTRAG file.

Invoice.dtaNumber ● String scalar​

The data transfer number of the invoice. This is available after the invoice is issued and the DTA is successfully created.

Invoice.dtaPayload ● Document object​

The DTA document containing payload information about this invoice. It's always in context with the instruction file.

Invoice.dtaSheet ● Document object​

The accompanying sheet which is send to the receiving office via mail (post office). It contains information about the client, the sender, the recipient and the corresponding DTA file. It's called a Begleitzettel.

Invoice.hints ● [String!] list scalar​

All hints and comments regarding the invoice (e.g. if data is not complete or consistent). This is usually used in combination with the following status: WARNING, DATA_ERROR and TECHNICAL_ERROR.

Invoice.id ● InvoiceID! non-null scalar​

Unique identifier

Invoice.invoiceDocument ● Document object​

The invoice as a PDF file

Invoice.invoiceNumber ● String scalar​

Continuously generated number of the invoice. This is not available for drafts.

Invoice.issuedAt ● Date scalar​

The date this invoice was issued. This is not available for drafts.

Invoice.month ● Date! non-null scalar​

Which calendar month is covered by the given invoice

Invoice.odooUrl ● Url scalar​

Link to the invoice in odoo.

Invoice.paymentCondition ● String! non-null scalar​

Payment condition of the invoice.

Invoice.pdfUrl ● String scalar​

Link to the PDF document of the invoice in Odoo

Invoice.performanceReport ● DividedPerformanceReport object​

(Optional) The associated performance report for this invoice. It's only present for invoices of type CARE_SERVICE.

Invoice.positions ● [InvoicePosition!]! non-null object​

List of the single positions of this invoice.

Invoice.recipient ● MailingAddress scalar​

The recipient of this issue. Can be null if required data is missing.

Invoice.recipientIK ● InstitutionCode scalar​

The institution code of the recipient. Only available if the recipient is a funding agency.

Invoice.recipientType ● InvoiceRecipientType enum​

Type of the recipient.

Invoice.reversalInvoiceNumber ● String scalar​

(Optional) Invoice number of the reversed invoice.

Invoice.reversalPdfUrl ● String scalar​

(Optional) Link to the PDF document of the reversed invoice.

Invoice.sendAt ● LocalDateTime scalar​

The date this invoice was send to the recipient. If it's send again this value is refreshed. This is not available for drafts.

Invoice.status ● InvoiceStatus! non-null enum​

Current status of the invoice

Invoice.total ● Float! non-null scalar​

The total sum of all invoice positions

Invoice.type ● InvoiceType! non-null enum​

Variant of the invoice.

Returned By​

appendInvoicePosition mutation ● invoice query ● invoices query

Member Of​

Client object ● InvoiceCollection object ● ResidentialPark object