Skip to content

Commit

Permalink
Update invoice.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
@bc-traciporter
bc-traciporter authored Oct 3, 2024
1 parent 4c35665 commit d2393e6
Showing 1 changed file with 30 additions and 29 deletions.
59 changes: 30 additions & 29 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 @@ -15,6 +15,7 @@ components:
securitySchemes:
authToken:
name: authToken
description: An API key is a token that you provide when making API calls. Include the token in a header parameter called `authToken`.
type: apiKey
in: header
responses:
Expand Down Expand Up @@ -424,7 +425,7 @@ paths:
invoiceNumber:
type: string
minLength: 1
description: 'Invoice Number, must be unique'
description: 'Invoice Number must be unique'
type:
type: string
minLength: 1
Expand All @@ -433,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, noted status will be auto set to 2 when open balance is <= 0'
purchaseOrderNumber:
type: string
minLength: 1
description: PO Number
details:
type: object
description: 'Invoice Details, noted this fields will be overridden by updating, so please get the original details values first before updating with it with entire details data'
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.'
properties:
header:
type: object
Expand Down Expand Up @@ -613,7 +614,7 @@ paths:
minLength: 1
description:
type: string
description: Product description or product name. This field is required for custom product.
description: Product description or product name. This field is required for a custom product.
minLength: 1
unitDiscount:
type: object
Expand All @@ -633,7 +634,7 @@ paths:
- unitPrice
source:
type: number
description: 'Mark the source of the invoice, 0 for B2B Edition, 1 for external'
description: 'Mark the source of the invoice, 0 for B2B Edition, 1 for external.'
originalBalance:
type: object
description: Invoice original balance
Expand Down Expand Up @@ -664,7 +665,7 @@ paths:
type: integer
externalPdfUrl:
type: string
description: The url of your external PDF file. The recommended file size should not exceed 5Mb. Please make sure that your file service has processed CORS. Using empty value if you want to delete it.
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. Using empty value if you want to delete it.
- $ref: https://raw.githubusercontent.com/bigcommerce/docs/main/docs/b2b-edition/models/extra_fields/extra_field_values.yaml
examples:
Update body with details field:
Expand Down Expand Up @@ -775,7 +776,7 @@ paths:
description: Invoice type
dueDate:
type: integer
description: 'due date, if empty, it will be set to default due date which is current date + pre-configured due days'
description: 'Due date, if empty, it will be set to the default due date which is the current date + pre-configured due days.'
status:
type: integer
default: 0
Expand Down Expand Up @@ -820,7 +821,7 @@ paths:
description: Amount
issuedAt:
type: number
description: The creation timestamp of the invoice current timestamp as default
description: The creation timestamp of the invoice. The current timestamp is the default.
details:
type: object
description: Invoice details
Expand All @@ -830,7 +831,7 @@ paths:
properties:
costLines:
type: array
description: 'Invoice cost infomation,not required，but if exists, some of the following sub fields will be required, this will be displayed on invoice detail page'
description: 'Invoice cost information is not required，but some of the sub-fields will be required if it exists. Invoice cost information is displayed on the invoice detail page.'
items:
type: object
properties:
Expand All @@ -849,13 +850,13 @@ 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
billingAddress:
type: object
description: 'Invoice billing address, not required，but if exists, some of the following sub fields will be required'
description: 'Invoice billing address is not required，but if it exists, some sub-fields will be required.'
properties:
city:
type: string
Expand Down Expand Up @@ -884,7 +885,7 @@ paths:
- firstName
shippingAddresses:
type: array
description: 'Invoice shipping addresses not required，but if exists, some of the following sub fields will be required, but 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 @@ -918,7 +919,7 @@ paths:
properties:
shipments:
type: array
description: 'Invoice shipment information, not required，but if exists, some of the following sub fields will be required, but 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 @@ -943,7 +944,7 @@ paths:
- comments
lineItems:
type: array
description: 'Invoice products infomation 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 @@ -973,10 +974,10 @@ paths:
description: amount
description:
type: string
description: Product description or product name. This field is required for custom product.
description: Product description or product name. This field is required for a custom product.
unitDiscount:
type: object
description: 'product unit discount not required，but if exists, some of the following sub fields will be required'
description: 'Product unit discount is not required，but if exists, some of the following sub fields will be required.'
properties:
code:
type: string
Expand All @@ -994,7 +995,7 @@ paths:
source:
type: number
default: 0
description: 'Source of invoice Mark the source of the invoice, 0 for B2B Edition, 1 for external'
description: 'Source of the invoice. Mark the source of the invoice, 0 for B2B Edition, 1 for external.'
enum:
- 0
- 1
Expand All @@ -1009,10 +1010,10 @@ paths:
description: ERP Customer ID
channelId:
type: integer
description: BigCommerce channel id
description: BigCommerce channel ID
externalPdfUrl:
type: string
description: The url of your external PDF file. The recommended file size should not exceed 5Mb. 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.
termsConditions:
type: string
description: Terms & Conditions. Visible on the default Invoice PDF.
Expand Down Expand Up @@ -1075,7 +1076,7 @@ paths:
unitPrice:
code: USD
value: '40.00'
description: Description is required for custom product
description: Description is required for a custom product.
customerId: '12345'
channelId: 1
Invoice body without details info:
Expand Down Expand Up @@ -1106,7 +1107,7 @@ paths:
properties:
id:
type: number
description: invoice id
description: invoice ID
meta:
type: object
properties:
Expand All @@ -1127,7 +1128,7 @@ paths:
value:
code: 400
data:
errMsg: The invoice number already exist
errMsg: The invoice number already exists
meta:
message: Bad Requests Error
tags:
Expand Down Expand Up @@ -1312,7 +1313,7 @@ paths:
type: string
in: query
name: q
description: 'Keyword queries are performed on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy"'
description: 'Keyword queries are performed on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy".'
- schema:
type: string
in: query
Expand All @@ -1322,7 +1323,7 @@ paths:
type: string
in: query
name: customerId
description: Query by invoice B2B Edition company id
description: Query by invoice B2B Edition company ID
- schema:
type: integer
enum:
Expand All @@ -1337,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 time 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 time period, with the "beginDateAt" parameter.'
- schema:
type: array
in: query
Expand All @@ -1360,7 +1361,7 @@ paths:
type: array
in: query
name: channelIds
description: BigCommerce channel ids
description: BigCommerce channel IDs
tags:
- Invoice
/invoices/export: {}
Expand All @@ -1371,7 +1372,7 @@ paths:
name: orderId
in: path
required: true
description: B2B Edition order id
description: B2B Edition order ID
post:
summary: Create invoice from order
tags:
Expand Down Expand Up @@ -1460,7 +1461,7 @@ paths:
type: string
externalPdfUrl:
type: string
description: The url of your external PDF file. The recommended file size should not exceed 5Mb. 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 d2393e6

Please sign in to comment.