Skip to content

Commit 3d7e885

Browse files
author
Kavin Ginige
committed
feat(accounting): Adds spec for invoice backorders and backorder-specific item fields Co-authored-by: Jonathan Hatlee <jonathan.hatlee@xero.com>"
1 parent 45ab7e8 commit 3d7e885

1 file changed

Lines changed: 46 additions & 1 deletion

File tree

xero_accounting.yaml

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7820,6 +7820,7 @@ paths:
78207820
- $ref: "#/components/parameters/summarizeErrors"
78217821
- $ref: "#/components/parameters/unitdp"
78227822
- $ref: "#/components/parameters/idempotencyKey"
7823+
- $ref: "#/components/parameters/allowBackorders"
78237824
responses:
78247825
"200":
78257826
description: Success - return response of type Invoices array with newly created Invoice
@@ -8133,6 +8134,7 @@ paths:
81338134
- $ref: "#/components/parameters/summarizeErrors"
81348135
- $ref: "#/components/parameters/unitdp"
81358136
- $ref: "#/components/parameters/idempotencyKey"
8137+
- $ref: "#/components/parameters/allowBackorders"
81368138
responses:
81378139
"200":
81388140
description: Success - return response of type Invoices array with newly created Invoice
@@ -8435,6 +8437,7 @@ paths:
84358437
- $ref: "#/components/parameters/InvoiceID"
84368438
- $ref: "#/components/parameters/unitdp"
84378439
- $ref: "#/components/parameters/idempotencyKey"
8440+
- $ref: "#/components/parameters/allowBackorders"
84388441
responses:
84398442
"200":
84408443
description: Success - return response of type Invoices array with updated Invoice
@@ -8949,6 +8952,28 @@ paths:
89498952
IsTrackedAsInventory: false
89508953
IsSold: true
89518954
IsPurchased: true
8955+
- ItemID: 5a70a272-a481-4bcf-a8ca-efffd923ab48
8956+
Code: fg78Ac
8957+
Description: Fender Stratocaster Sunburst
8958+
PurchaseDescription: Fender Stratocaster Sunburst
8959+
UpdatedDateUTC: /Date(1552331874000+0000)/
8960+
PurchaseDetails:
8961+
UnitPrice: 1500.0000
8962+
COGSAccountCode: "500"
8963+
TaxType: ""
8964+
SalesDetails:
8965+
UnitPrice: 5000.0000
8966+
AccountCode: "200"
8967+
TaxType: OUTPUT2
8968+
Name: Fender Stratocaster
8969+
IsTrackedAsInventory: true
8970+
InventoryAssetAccountCode: "140"
8971+
TotalCostPool: 0.00
8972+
QuantityOnHand: 0.0000
8973+
QuantityAvailable: 0.0000
8974+
QuantityOnBackOrder: 0.0000
8975+
IsSold: true
8976+
IsPurchased: true
89528977
put:
89538978
security:
89548979
- OAuth2:
@@ -9196,6 +9221,8 @@ paths:
91969221
InventoryAssetAccountCode: "630"
91979222
TotalCostPool: 25000.00
91989223
QuantityOnHand: 10.0000
9224+
QuantityAvailable: 10.0000
9225+
QuantityOnBackOrder: 0.0000
91999226
IsSold: true
92009227
IsPurchased: true
92019228
ValidationErrors: []
@@ -19828,6 +19855,14 @@ components:
1982819855
example: KEY_VALUE
1982919856
schema:
1983019857
type: string
19858+
allowBackorders:
19859+
in: query
19860+
name: allowBackorders
19861+
x-snake: allow_backorders
19862+
description: Allows an invoice to be created even when one or more line items contain tracked inventory where the invoice quantity would cause the available quantity to go negative
19863+
example: true
19864+
schema:
19865+
type: boolean
1983119866
includeOnline:
1983219867
in: query
1983319868
name: IncludeOnline
@@ -22649,10 +22684,20 @@ components:
2264922684
format: double
2265022685
x-is-money: true
2265122686
QuantityOnHand:
22652-
description: The quantity of the item on hand
22687+
description: The quantity of the item on hand. This will be 0 if `QuantityOnBackOrder` is greater than 0.
2265322688
type: number
2265422689
format: double
2265522690
x-is-money: true
22691+
QuantityAvailable:
22692+
description: The quantity of the item available. This is equal to `QuantityOnHand` - `QuantityOnBackOrder`. This value will be negative if `QuantityOnBackOrder` is greater than 0.
22693+
type: number
22694+
format: double
22695+
readOnly: true
22696+
QuantityOnBackOrder:
22697+
description: The quantity of the item on backorder. This will be 0 if `QuantityOnHand` is greater than 0.
22698+
type: number
22699+
format: double
22700+
readOnly: true
2265622701
UpdatedDateUTC:
2265722702
description: Last modified date in UTC format
2265822703
type: string

0 commit comments

Comments
 (0)