API reference / Quittio \ Core \ Builder \ Concerns
BuildsReferences
trait in quittio/core
Quittio\Core\Builder\Concerns\BuildsReferences · Source
Document references (BT-10 to BT-19, BG-3) and the invoiced object.
Part of InvoiceBuilder, which holds the state; use the builder, not the trait.
Methods#
| Method | Description |
|---|---|
->buyerAccountingReference() | The buyer's accounting reference (BT-19), e.g. a cost centre; null removes it. |
->buyerReference() | Buyer reference (BT-10). For public sector buyers in Germany this is the Leitweg-ID. |
->contractReference() | Contract reference (BT-12); null removes it. |
->despatchAdviceReference() | Despatch advice reference (BT-16); null removes it. |
->invoicedObject() | Identifier of the invoiced object (BT-18), e.g. a meter or subscription number, with its scheme (BT-18-1). |
->precedingInvoice() | Adds a reference to a preceding invoice (BG-3): its number (BT-25) and issue date (BT-26), e.g. for a corrected invoice or a credit note. |
->projectReference() | Project reference (BT-11) with the project name, which CII requires in addition to the identifier. |
->purchaseOrderReference() | The buyer's purchase order reference (BT-13); null removes it. |
->receivingAdviceReference() | Receiving advice reference (BT-15); null removes it. |
->salesOrderReference() | The seller's sales order reference (BT-14); null removes it. |
->tenderReference() | Tender or lot reference (BT-17); null removes it. |
buyerAccountingReference()#
public function buyerAccountingReference(?string $reference): staticThe buyer's accounting reference (BT-19), e.g. a cost centre; null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
buyerReference()#
public function buyerReference(?string $reference): staticBuyer reference (BT-10). For public sector buyers in Germany this is the Leitweg-ID.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
contractReference()#
public function contractReference(?string $reference): staticContract reference (BT-12); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
despatchAdviceReference()#
public function despatchAdviceReference(?string $reference): staticDespatch advice reference (BT-16); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
invoicedObject()#
public function invoicedObject(string $value, string|RawCode|null $scheme = null): staticIdentifier of the invoiced object (BT-18), e.g. a meter or subscription number, with its scheme (BT-18-1).
| Parameter | Type | Description |
|---|---|---|
$value | string | |
$scheme | string|RawCode|null = null |
- Returns
static
precedingInvoice()#
public function precedingInvoice(
string $number,
Date|DateTimeInterface|string|null $issueDate = null,
): staticAdds a reference to a preceding invoice (BG-3): its number (BT-25) and issue date (BT-26), e.g. for a corrected invoice or a credit note.
| Parameter | Type | Description |
|---|---|---|
$number | string | |
$issueDate | Date|DateTimeInterface|string|null = null |
- Returns
static
projectReference()#
public function projectReference(string $id, ?string $name = null): staticProject reference (BT-11) with the project name, which CII requires in addition to the identifier.
| Parameter | Type | Description |
|---|---|---|
$id | string | |
$name | ?string = null |
- Returns
static
purchaseOrderReference()#
public function purchaseOrderReference(?string $reference): staticThe buyer's purchase order reference (BT-13); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
receivingAdviceReference()#
public function receivingAdviceReference(?string $reference): staticReceiving advice reference (BT-15); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
salesOrderReference()#
public function salesOrderReference(?string $reference): staticThe seller's sales order reference (BT-14); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static
tenderReference()#
public function tenderReference(?string $reference): staticTender or lot reference (BT-17); null removes it.
| Parameter | Type | Description |
|---|---|---|
$reference | ?string |
- Returns
static