Skip to content

Commit

Permalink
feat: add payment information
Browse files Browse the repository at this point in the history
  • Loading branch information
BenjaminMoe committed Oct 24, 2023
1 parent 02af96d commit 06fa087
Showing 1 changed file with 155 additions and 4 deletions.
159 changes: 155 additions & 4 deletions docs/openapi/components/schemas/credentials/EInvoiceCredential.yml
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,10 @@ properties:
type: string
enum:
- Invoice
taxIdNumber:
title: Tax Id Number
description: Tax Id for Documents such as SAT
type: string
relatedDocuments:
title: Documents Linked or Referenced
description: References to other documents which can be used to support the claims of the current document
Expand All @@ -231,10 +235,6 @@ properties:
type:
const: LinkedDocument
default: LinkedDocument
documentId:
title: Document Identifier
description: The Identifier of the document being referenced
type: string
documentType:
title: Document Type
description: The type of the document being referenced
Expand All @@ -245,6 +245,12 @@ properties:
- BillOfLading
- CertificationOfOrigin
- LetterOfCredit
- ProFormaInvoice
- Other
documentId:
title: Document Identifier
description: The Identifier of the document being referenced
type: string
buyer:
title: Buyer
description: Importer of record. Party placing the order or paying the invoice.
Expand Down Expand Up @@ -382,6 +388,10 @@ properties:
title: Product Identifier
description: The product identifier, such as ISBN.
type: string
batchNumber:
title: Batch Number
description: A tracking number for commodities
type: string
price:
title: Price
description: >-
Expand Down Expand Up @@ -623,6 +633,147 @@ properties:
The currency of the price, or a price component when attached to
PriceSpecification and its subtypes.
type: string
paymentDetails:
title: Payment Details (optional)
description: Information on the payment details to the beneficiary
type: array
items:
type: object
properties:
type:
type: array
readOnly: true
const:
- PaymentDetails
default:
- PaymentDetails
items:
type: string
enum:
- PaymentDetails
beneficiaryName:
title: Beneficiary Name
description: Name of the Beneficiary
type: string
beneficiaryAddress:
title: Beneficiary Address
description: The postal address of the Beneficiary
type: object
properties:
type:
type: array
readOnly: true
const:
- PostalAddress
default:
- PostalAddress
items:
type: string
enum:
- PostalAddress
streetAddress:
title: Street Address
description: >-
The street address expressed as free form text. The street address is
printed on paper as the first lines below the name. For example, the name
of the street and the number in the street or the name of a building.
type: string
addressLocality:
title: Address Locality
description: Text specifying the name of the locality; for example, a city.
type: string
addressRegion:
title: Address Region
description: >-
Text specifying a province or state in abbreviated format; for example,
NJ.
type: string
addressCountry:
title: Address Country
description: >-
The two-letter ISO 3166-1 alpha-2 country code.
type: string
postalCode:
title: Postal Code
description: Text specifying the postal code for an address.
type: string
additionalProperties: false
required:
- type
bankName:
title: Bank Name
description: Name of the bank
type: string
bankAddress:
title: Bank Address
description: The postal address of the bank
type: object
properties:
type:
type: array
readOnly: true
const:
- PostalAddress
default:
- PostalAddress
items:
type: string
enum:
- PostalAddress
streetAddress:
title: Street Address
description: >-
The street address expressed as free form text. The street address is
printed on paper as the first lines below the name. For example, the name
of the street and the number in the street or the name of a building.
type: string
addressLocality:
title: Address Locality
description: Text specifying the name of the locality; for example, a city.
type: string
addressRegion:
title: Address Region
description: >-
Text specifying a province or state in abbreviated format; for example,
NJ.
type: string
addressCountry:
title: Address Country
description: >-
The two-letter ISO 3166-1 alpha-2 country code.
type: string
postalCode:
title: Postal Code
description: Text specifying the postal code for an address.
type: string
additionalProperties: false
required:
- type
transitNumber:
title: Transit Number
description: A nine-digit number that helps financial institutions identify what institution issued checks or other documents financial documents
type: string
institutionNumber:
title: Institution Number
description: A unique code assigned to a certain bank or financial institution to identify them
type: string
accountNumber:
title: Account Number
description: The account number of the beneficiary at the bank
type: string
swiftCode:
title: Swift Code
description: Swift code for the financial institution
type: string
routingNumber:
title: Routing Number
description: Routing Number for the institution
type: string
additionalProperties: false
required:
- type
minItems: 0
maxItems: 1
discounts:
title: Discounts (optional)
description: Reductions in price applied to the subtotal
Expand Down

0 comments on commit 06fa087

Please sign in to comment.