Skip to content

Commit

Permalink
Update invoice.yaml - more updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@bc-traciporter
bc-traciporter authored Oct 4, 2024
1 parent 2c0ff9b commit 7200fbf
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -434,14 +434,14 @@ paths:
description: Invoice due date
status:
type: number
description: 'Invoice status, noted status will be auto set to 2 when open balance is <= 0'
description: 'Invoice status will be auto-set to 2 when the open balance is <= 0.'
purchaseOrderNumber:
type: string
minLength: 1
description: PO Number
details:
type: object
description: 'Invoice Details, noted this field will be overridden by updating, so please get the original details values first before updating with it with entire details data.'
description: 'Updating will override the invoice details; therefore, ensure you get the original values before updating all the data.'
properties:
header:
type: object
Expand Down Expand Up @@ -614,7 +614,7 @@ paths:
minLength: 1
description:
type: string
description: Product description or product name. This field is required for a custom product.
description: The product description or product name is a requirement for a custom product.
minLength: 1
unitDiscount:
type: object
Expand Down Expand Up @@ -850,7 +850,7 @@ paths:
description: amount
description:
type: string
description: Price description e.g., Subtotal or other types of prices or fees.
description: Price description. e.g., Subtotal or other types of prices or fees.
required:
- amount
- description
Expand Down Expand Up @@ -885,7 +885,7 @@ paths:
- firstName
shippingAddresses:
type: array
description: 'Invoice shipping addresses is not required，but if exists, some of the following sub fields will be required, but an empty string is allowed.'
description: 'Invoice shipping addresses is not required，but if exists, some of the following sub-fields will be required, but an empty string is allowed.'
items:
type: object
properties:
Expand Down Expand Up @@ -919,7 +919,7 @@ paths:
properties:
shipments:
type: array
description: 'Invoice shipment information is not required，but if exists, some of the following sub fields will be required, but an empty string is allowed.'
description: 'Invoice shipment information is not required，but if exists, some of the following sub-fields will be required, but an empty string is allowed.'
items:
type: object
properties:
Expand All @@ -928,7 +928,7 @@ paths:
description: address ID
shipDate:
type: string
description: shipment time
description: shipment
shipVia:
type: string
trackingNumber:
Expand All @@ -944,7 +944,7 @@ paths:
- comments
lineItems:
type: array
description: 'Invoice products infomation is not required，but if exists, some of the following sub fields will be required.'
description: 'Invoice products infomation is not required，but if exists, some of the following sub-fields will be required.'
items:
type: object
properties:
Expand Down Expand Up @@ -974,10 +974,10 @@ paths:
description: amount
description:
type: string
description: Product description or product name. This field is required for a custom product.
description: The product description or product name is a requirement for a custom product.
unitDiscount:
type: object
description: 'Product unit discount is not required，but if exists, some of the following sub fields will be required.'
description: 'The product unit discount is not required，but if exists, some of the following sub-fields will be required.'
properties:
code:
type: string
Expand Down Expand Up @@ -1076,7 +1076,7 @@ paths:
unitPrice:
code: USD
value: '40.00'
description: Description is required for a custom product.
description: The description is a requirement for a custom product.
customerId: '12345'
channelId: 1
Invoice body without details info:
Expand Down Expand Up @@ -1128,7 +1128,7 @@ paths:
value:
code: 400
data:
errMsg: The invoice number already exists
errMsg: The invoice number already exists.
meta:
message: Bad Requests Error
tags:
Expand Down Expand Up @@ -1338,12 +1338,12 @@ paths:
type: string
in: query
name: beginDateAt
description: 'Query by the created time period, with the "endDateAt" parameter.'
description: 'Query by the created period, with the "endDateAt" parameter.'
- schema:
type: string
in: query
name: endDateAt
description: 'Query by the created time period, with the "beginDateAt" parameter.'
description: 'Query by the created period, with the "beginDateAt" parameter.'
- schema:
type: array
in: query
Expand Down Expand Up @@ -1461,7 +1461,7 @@ paths:
type: string
externalPdfUrl:
type: string
description: The url of your external PDF file. The recommended file size should not exceed 5 Mb. Please make sure that your file service has processed CORS.
description: The URL of your external PDF file. The recommended file size should not exceed 5 Mb. Please make sure that your file service has processed CORS.
meta:
type: object
properties:
Expand Down

0 comments on commit 7200fbf

Please sign in to comment.