Skip to content

Commit b76393e

Browse files
committed
Added info on raise behaviour
1 parent 6981a31 commit b76393e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

pages/proforma-invoices/proforma-invoice-object.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,19 @@ attributes:
102102
name: still_to_pay
103103
type: decimal
104104
description: Amount of the Proforma Invoice that still needs to be payed.
105+
-
106+
name: description
107+
type: string
108+
description: Description for the Proforma Invoice item (required for creation).
109+
-
110+
name: send_pfi
111+
type: boolean
112+
description: |
113+
(Deprecated - use raise_behaviour instead) Send the PFI as well as creating it. Default is false.
114+
-
115+
name: raise_behaviour
116+
type: string
117+
description: |
118+
Raise behavior when creating a Proforma Invoice. Choices are `dont-raise` (default), `raise`, or `raise-and-send`.
119+
If `dont-raise` is used, the PFI will be created but not sent. If `raise` is used, the PFI will be created and staged.
120+
If `raise-and-send` is used, the PFI will be created, staged, and sent to the client.

0 commit comments

Comments
 (0)