API reference / Quittio \ Core \ Builder \ Concerns

BuildsNotesAndAttachments

trait in quittio/core

Quittio\Core\Builder\Concerns\BuildsNotesAndAttachments · Source

Invoice notes (BG-1) and supporting documents (BG-24).

Part of InvoiceBuilder, which holds the state; use the builder, not the trait.

Methods#

Method	Description
`->attachment()`	Supporting document (BG-24), either embedded ($content) or as external link.
`->note()`	Adds an invoice note (BG-1): the text (BT-22) and an optional subject code (BT-21, UNTDID 4451, e.g. "REG" for regulatory information). Unknown codes are kept as RawCode.

`attachment()`#

public function attachment(
    string $id,
    ?string $content = null,
    MimeType|string|null $mimeType = null,
    ?string $filename = null,
    ?string $description = null,
    ?string $externalUri = null,
): static

Supporting document (BG-24), either embedded ($content) or as external link.

Parameter	Type	Description
`$id`	`string`
`$content`	`?string` = `null`
`$mimeType`	`MimeType\|string\|null` = `null`
`$filename`	`?string` = `null`
`$description`	`?string` = `null`
`$externalUri`	`?string` = `null`

Returns: static

`note()`#

public function note(
    string $content,
    NoteSubjectCode|RawCode|string|null $subject = null,
): static

Adds an invoice note (BG-1): the text (BT-22) and an optional subject code (BT-21, UNTDID 4451, e.g. "REG" for regulatory information). Unknown codes are kept as RawCode.

Parameter	Type	Description
`$content`	`string`
`$subject`	`NoteSubjectCode\|RawCode\|string\|null` = `null`

Returns: static

BuildsNotesAndAttachments

Methods#

attachment()#

note()#

`attachment()`#

`note()`#