--- openapi: "3.0.2" info: title: "" description: "" contact: name: "" url: "" email: "example@example.org" version: "" paths: /remittanceAdvice: summary: "" description: "" post: summary: "" description: "" tags: - "Remittance Advice" requestBody: description: "" content: application/json: schema: $ref: "#/components/schemas/post-remittanceAdvice-oagis-id-cd39e0e12541488ab6a55fd81ec6aa82" responses: "200": description: "" content: application/json: {} components: schemas: token: type: "string" normalizedString: type: "string" base64Binary: type: "string" string: type: "string" decimal: type: "number" xbt_MonthType: type: "string" xbt_YearType: type: "string" post-remittanceAdvice-oagis-id-cd39e0e12541488ab6a55fd81ec6aa82: required: - "remittanceAdvice" additionalProperties: false properties: remittanceAdvice: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "BAI - HeaderService/ ServiceType" example: "BAI" actionCode: allOf: - $ref: "#/components/schemas/token" - example: "Add" remittanceAdviceHeader: description: "This remittance advice header commutes a payment header\ \ information, including the customer (billTo), supplier (remitTo)\ \ and the payment amount. Batch summary is represent as an extension\ \ as a batch of remittance advice payload is represented as an array." type: "object" additionalProperties: false properties: identifier: description: "BAI - Headers / LockBox Header / LockboxNumber" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/normalizedString" - example: "3AFDFD09-1282-4DD5-AE34-9142662FB503" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "Lockbox.identifier" example: "Lockbox Number" documentDateTime: allOf: - $ref: "#/components/schemas/token" - description: "BAI - Headers / LockBox Header / LedgerDateOfCredit" example: "2020-09-18T08:33:04-05:00" attachment: type: "array" items: type: "object" additionalProperties: false properties: embeddedDataBinaryObject: allOf: - $ref: "#/components/schemas/base64Binary" - description: "base64 image of check , merged front and back" example: "BLOB" uri: allOf: - $ref: "#/components/schemas/normalizedString" - description: "URI reference to customer's check image" example: "https://remittancefiles.com/" fileName: allOf: - $ref: "#/components/schemas/string" - example: "remittance2020-12-07.png" status: type: "array" items: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "891E37BE-044A-4B89-A0E2-AB512246E9FB" code: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" typeCode: allOf: - $ref: "#/components/schemas/token" - example: "Remittance Type A" description: allOf: - $ref: "#/components/schemas/string" - example: "This is an example description for remittance" reasonCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "Closing Out" reason: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "End of Year Closeout" effectiveTimePeriod: type: "object" additionalProperties: false properties: startDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2020-09-18T08:33:04-05:00" endDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2020-09-18T08:33:04-05:00" effectiveDate: allOf: - $ref: "#/components/schemas/token" - description: "BAI - Headers / LockBox Header / LedgerDateOfCredit" example: "2020-12-07" initiatingParty: description: "Use only if third party is making payment on behalf\ \ of customer" type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "2345" accountIdentifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" name: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "Bank of OAGIS" location: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "54321" name: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "Downtown Branch" postalAddress: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" name: allOf: - $ref: "#/components/schemas/string" - example: "Accounts Receivable" addressLine: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "345 Sample Street" cityName: allOf: - $ref: "#/components/schemas/string" - example: "Atlanta" countrySubDivisionCode: type: "array" items: allOf: - $ref: "#/components/schemas/token" - example: "GA" countryCode: allOf: - $ref: "#/components/schemas/token" - example: "US" postalCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "30316" billToParty: type: "object" additionalProperties: false properties: typeCode: $ref: "#/components/schemas/token" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234" accountIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "54321" name: allOf: - $ref: "#/components/schemas/string" - example: "Acme Corp" remitToParty: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234" checkInstruction: type: "object" additionalProperties: false properties: checkNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "BAI - Transaction/TransactionDetail/CheckNumber" example: "1000458345" deliveryMethodCode: allOf: - $ref: "#/components/schemas/token" - example: "123" checkMaturityDate: allOf: - $ref: "#/components/schemas/token" - example: "2021-02-16" checkMemoFieldText: allOf: - $ref: "#/components/schemas/string" - example: "For discount refund" routingNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "BAI - Transaction/TransactionDetail/TransitRoutingNumber" example: "893458" accountIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "BAI - Transaction/TransactionDetail/AccountNumber" example: "1234567" accountName: allOf: - $ref: "#/components/schemas/string" - example: "Personal Checking" nameOnAccount: allOf: - $ref: "#/components/schemas/string" - example: "John Doe" paymentMethodCode: allOf: - $ref: "#/components/schemas/token" - example: "123" totalAmount: description: "BAI Transaction/TransactionDetail/DollarAmount maps\ \ to content - this is the payment amount" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "438.23" currencyCode: allOf: - $ref: "#/components/schemas/token" - description: "USA" transactionIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "BAI - Transaction/TransactionDetail/ItemNumber" example: "B162190C-6F3C-40D3-B5BE-46FEB4E7C570" paymentAuthorization: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "B162190C-6F3C-40D3-B5BE-46FEB4E7C570" authorizationDate: allOf: - $ref: "#/components/schemas/token" - example: "2021-02-01" debitCard: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Card Identifier" example: "4474-4567-8374-9980" nameOnAccount: allOf: - $ref: "#/components/schemas/string" - example: "John Doe" expiration: type: "object" additionalProperties: false properties: month: allOf: - $ref: "#/components/schemas/xbt_MonthType" - description: "two digit month" example: "12" year: allOf: - $ref: "#/components/schemas/xbt_YearType" - description: "two or four digit year" example: "2024" companyName: allOf: - $ref: "#/components/schemas/string" - example: "Acme Corp" pin: allOf: - $ref: "#/components/schemas/normalizedString" - example: "0112" creditCard: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "4474-8513-565-9913" nameOnAccount: allOf: - $ref: "#/components/schemas/string" - example: "John Doe" expiration: type: "object" additionalProperties: false properties: month: allOf: - $ref: "#/components/schemas/xbt_MonthType" - example: "12" year: allOf: - $ref: "#/components/schemas/xbt_YearType" - example: "2024" companyName: allOf: - $ref: "#/components/schemas/string" - example: "Acme Corp" paymentAuthorization: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "85D40EBB-E080-4FB0-B99D-4D116FC57361" responseCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "Success" authorizationDate: allOf: - $ref: "#/components/schemas/token" - example: "2021-02-01" amount: allOf: - $ref: "#/components/schemas/decimal" - example: "431.23" referenceOrderNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" remittanceBankIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "Bank of OAGIS" cardCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "three to four digit security code" example: "816" billingAddress: type: "object" additionalProperties: false properties: name: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "John Doe" addressLine: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "123 Sample Street" countrySubDivisionCode: type: "array" maxItems: 2 items: allOf: - $ref: "#/components/schemas/token" - description: "State (if USA) or Province (Canada, Mexico)" example: "Georgia" countryCode: allOf: - $ref: "#/components/schemas/token" - example: "US" postalCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "30316" electronicFundsTransfer: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "46CCC1C5-83ED-4816-8BD4-17FAFDAFB61B" nameOnAccount: allOf: - $ref: "#/components/schemas/string" - example: "John Doe" routingNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345678" bankName: allOf: - $ref: "#/components/schemas/string" - example: "Bank of OAGIS" extension: type: "array" items: type: "object" additionalProperties: false properties: amount: type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "431.23" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "BatchTotalAmount" currencyCode: allOf: - $ref: "#/components/schemas/token" - description: "USA" dateTime: description: "BAI - Transaction/BatchHeader/ LedgerDateOfCredit\n" type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/token" - example: "2021-02-01" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "BatchDate" quantity: type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "14" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "BAI - Transaction/BatchTrailer/ TotalItems\ \ - number of payments in a batch" remittanceAdviceLine: type: "array" items: type: "object" additionalProperties: false properties: typeCode: $ref: "#/components/schemas/token" lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Sequential identifier" example: "4" description: allOf: - $ref: "#/components/schemas/string" - example: "This is a refund for a discounted item" note: allOf: - $ref: "#/components/schemas/string" - example: "We're paying back the customer." status: description: "status of the invoice payment, whether it is paid\ \ in full, or partial\nPAID\nPARTIAL" type: "object" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234" description: allOf: - $ref: "#/components/schemas/string" - example: "This refund has been processed" reasonCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234" reason: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "Discount Refund" paymentAmount: allOf: - $ref: "#/components/schemas/decimal" - description: "amount paid specific to that invoice or invoice\ \ line\n\nBAI - Transaction/InvoiceDetail[BatchNumber=Transaction/BatchHeader\ \ / BatchNumber\n And ItemNumber=Transaction/TransactionDetail/ItemNumber]/InvoiceAmount1\n" example: "431.23" invoiceReference: description: "Invoice Identifier, not at a line line" type: "array" items: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "BAI Transaction/InvoiceDetail[BatchNumber=Transaction/BatchHeader\ \ / BatchNumber AND ItemNumber=Transaction/TransactionDetail/ItemNumber]/InvoiceNumber1" example: "3" description: allOf: - $ref: "#/components/schemas/string" - example: "Sample Invoice" note: allOf: - $ref: "#/components/schemas/string" - example: "This is a refund invoice" lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "2" invoiceAdjustment: description: "Adjustment specific to an invoice or invoice\ \ line" type: "array" items: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "51F8E6AB-61BB-4448-A25F-326BEF4DE3E2" invoiceDispute: type: "array" items: type: "object" additionalProperties: false properties: lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "2" disputedAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.58" adjustedInvoiceTotalAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.58" adjustedTotalTaxAmount: allOf: - $ref: "#/components/schemas/decimal" - example: ".83" invoiceLineDisputeDetail: type: "array" items: type: "object" additionalProperties: false properties: lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "2" customerPriceListPrice: type: "object" additionalProperties: false properties: chargeAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.53" quantityRange: type: "object" additionalProperties: false properties: minimumQuantity: allOf: - $ref: "#/components/schemas/decimal" - example: "0" maximumQuantity: allOf: - $ref: "#/components/schemas/decimal" - example: "99" unitAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.53" adjustedInvoiceLineAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.53" disputedAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "14.53" orderedItem: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" customerItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "98765" supplierItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "9192939" gtinid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234567890123" description: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "This is a widget" shippedItemInstance: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Shipped item instance\ \ is often used if the wrong product\ \ was shipped. Use Ordered Item\ \ to indicate the actual product\ \ ordered, whereas a substitute\ \ equivalent may have been shipped,\ \ or supplier's stocking identifier\ \ may have been wrong." example: "12345" customerItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "98765" supplierItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "9192939" gtinid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1234567890123" invoiceAllowance: type: "array" items: type: "object" additionalProperties: false properties: identifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "D6B8E83A-4A44-4BFD-A69A-5CD8F597A9B2" basisAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "2.14" basisQuantity: allOf: - $ref: "#/components/schemas/decimal" - example: "6" description: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "These are example widgets" amount: allOf: - $ref: "#/components/schemas/decimal" - example: "4.16" reasonCode: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - example: "Discounted refund" currencyExchangeRate: type: "array" items: type: "object" additionalProperties: false properties: sourceCurrencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" targetCurrencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" rateNumber: allOf: - $ref: "#/components/schemas/decimal" - example: "4" setDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2021-02-01" sourceIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12345" timePeriod: type: "object" additionalProperties: false properties: startDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2020-09-18T08:33:04-05:00" endDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2020-09-18T08:33:04-06:00" tax: type: "array" items: type: "object" additionalProperties: false properties: basisAmount: allOf: - $ref: "#/components/schemas/decimal" - example: "4.16" basisQuantity: allOf: - $ref: "#/components/schemas/decimal" - example: "6" calculation: type: "object" additionalProperties: false properties: rateNumber: allOf: - $ref: "#/components/schemas/decimal" - example: "90.1" taxAuthorityAmount: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "7.5" currencyCode: $ref: "#/components/schemas/token" amount: allOf: - $ref: "#/components/schemas/decimal" - example: "43.16" promotionReference: type: "array" items: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Identifier for the promotion,\ \ such as a end cap, coupon identifier,\ \ etc." example: "F4D97397-6F55-4E5A-B65C-FD4FAB9159C0"