eedm.payment-transactions.v12.1.0.payment-transactions.json Maven / Gradle / Ivy
{
"title" : "Payment Transactions",
"description" : "The details of transactions representing disbursements from the institution.",
"version" : "12.1.0",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "resource:/eedm/metadata.json"
},
"id" : {
"title" : "ID",
"description" : "The global identifier of the payment transaction.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
},
"documentNumber" : {
"title" : "Document Number",
"description" : "The document number associated with the payment transaction (i.e. check number, payment transaction number).",
"type" : "string",
"minLength" : 1
},
"referenceNumber" : {
"title" : "Reference Number",
"description" : "The reference number associated with the payment transaction.",
"type" : "string"
},
"paymentMethod" : {
"title" : "Payment Method",
"description" : "The payment method used for the transaction.",
"enum" : [ "check", "directDeposit", "wire", "eCheck", "creditCard", "debitCard" ],
"type" : "string"
},
"paymentDate" : {
"title" : "Payment Date",
"description" : "The date the payment occurred.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
},
"paymentsFor" : {
"title" : "Payments For",
"description" : "The invoices or refunds for which the payment occurred.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"document" : {
"title" : "Document",
"description" : "The invoice or refunds for which the payment occurred.",
"oneOf" : [ {
"title" : "Invoice",
"description" : "The invoice for which the payment occurred.",
"type" : "object",
"properties" : {
"invoice" : {
"title" : "Invoice",
"description" : "The invoice for which the payment occurred.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Invoice.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/accounts-payable-invoices/{id}",
"targetSchema" : {
"$ref" : "accounts-payable-invoices.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
},
"referenceDocument" : {
"title" : "Reference Document",
"description" : "The originating purchase order or encumbrance document associated with the invoice.",
"oneOf" : [ {
"title" : "Purchase Order",
"description" : "The originating purchase order associated with the invoice.",
"type" : "object",
"properties" : {
"purchaseOrder" : {
"title" : "Purchase Order",
"description" : "The originating purchase order associated with the invoice.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Purchase Order.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/purchase-orders/{id}",
"targetSchema" : {
"$ref" : "purchase-orders.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "purchaseOrder" ]
}, {
"title" : "Blanket Purchase Order",
"description" : "The originating blanket purchase order associated with the invoice.",
"type" : "object",
"properties" : {
"blanketPurchaseOrder" : {
"title" : "Blanket Purchase Order",
"description" : "The originating blanket purchase order associated with the invoice.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Blanket Purchase Order.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/blanket-purchase-orders/{id}",
"targetSchema" : {
"$ref" : "blanket-purchase-orders.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "blanketPurchaseOrder" ]
}, {
"title" : "Recurring Voucher",
"description" : "The originating recurring voucher associated with the invoice.",
"type" : "object",
"properties" : {
"recurringVoucher" : {
"title" : "Recurring Voucher",
"description" : "The originating recurring voucher associated with the invoice.",
"type" : "string",
"minLength" : 1
}
},
"additionalProperties" : false,
"required" : [ "recurringVoucher" ]
}, {
"title" : "Purchasing Arrangement",
"description" : "The originating purchasing arrangement associated with the invoice.",
"type" : "object",
"properties" : {
"purchasingArrangement" : {
"title" : "Purchasing Arrangement",
"description" : "The originating purchasing arrangement associated with the invoice.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Purchasing Arrangement.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/purchasing-arrangements/{id}",
"targetSchema" : {
"$ref" : "purchasing-arrangements.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "purchasingArrangement" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"lineItems" : {
"title" : "Line Items",
"description" : "The line items for which the payment occurred.",
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"number" : {
"title" : "Number",
"description" : "The line item number.",
"type" : "string"
},
"amount" : {
"title" : "Amount",
"description" : "The amount associated with the line item.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
}
}
},
"additionalProperties" : false,
"required" : [ "invoice" ]
}, {
"title" : "Refund",
"description" : "The refund for which the payment occurred.",
"type" : "object",
"properties" : {
"refund" : {
"title" : "Refund",
"description" : "The refund for which the payment occurred.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Refund.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/student-refunds/{id}",
"targetSchema" : {
"$ref" : "student-refunds.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "refund" ]
} ]
},
"amount" : {
"title" : "Amount",
"description" : "The amount paid for the invoice or refund.",
"oneOf" : [ {
"type" : "object",
"format" : "currency",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
}
},
"amount" : {
"title" : "Amount",
"description" : "The total amount paid as part of the transaction.",
"format" : "currency",
"type" : "object",
"properties" : {
"value" : {
"title" : "Value",
"description" : "The monetary value",
"type" : "number"
},
"currency" : {
"title" : "Currency",
"description" : "The ISO 4217 currency code",
"enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWL" ],
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "value", "currency" ]
},
"payeeDetails" : {
"title" : "Payee Details",
"description" : "The details associated with the payee.",
"type" : "object",
"properties" : {
"payee" : {
"title" : "Payee",
"description" : "The payee associated with the transaction.",
"oneOf" : [ {
"title" : "Person",
"description" : "The person who is the payee.",
"type" : "object",
"properties" : {
"person" : {
"title" : "Person",
"description" : "The person who is the payee.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Person.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/persons/{id}",
"targetSchema" : {
"$ref" : "persons.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "person" ]
}, {
"title" : "Organization",
"description" : "The organization which is the payee.",
"type" : "object",
"properties" : {
"organization" : {
"title" : "Organization",
"description" : "The organization which is the payee.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Organization.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/organizations/{id}",
"targetSchema" : {
"$ref" : "organizations.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "organization" ]
}, {
"title" : "Institution",
"description" : "The institution which is the payee.",
"type" : "object",
"properties" : {
"institution" : {
"title" : "Institution",
"description" : "The institution which is the payee.",
"type" : "object",
"properties" : {
"id" : {
"title" : "ID",
"description" : "The global identifier for the Institution.",
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
},
"links" : [ {
"rel" : "self",
"href" : "/educational-institutions/{id}",
"targetSchema" : {
"$ref" : "educational-institutions.json#"
}
} ],
"additionalProperties" : false,
"required" : [ "id" ]
}
},
"additionalProperties" : false,
"required" : [ "institution" ]
} ]
},
"name" : {
"title" : "Name",
"description" : "The full name of the payee.",
"type" : "string"
},
"addressLines" : {
"title" : "Address Lines",
"description" : "The address lines of the person's location, such as a street address, post office box number, or city, region, and postal code.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"place" : {
"title" : "Place",
"description" : "A country specific postal region. Postal regions are expressed as a hierarchy of country, region, and sub-region, and as a locality with postal automation codes.",
"oneOf" : [ {
"type" : "object",
"format" : "place",
"properties" : {
"country" : {
"title" : "Country",
"description" : "The country specific postal region definition.",
"oneOf" : [ {
"title" : "Australia",
"description" : "The postal region definition for Australia.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for Australia.",
"enum" : [ "AUS" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "AUSTRALIA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "AU-NSW", "AU-ACT", "AU-VIC", "AU-QLD", "AU-SA", "AU-WA", "AU-TAS", "AU-NT" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(0[289][0-9]{2})|([1345689][0-9]{3})|(2[0-8][0-9]{2})|(290[0-9])|(291[0-4])|(7[0-4][0-9]{2})|(7[8-9][0-9]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Brazil",
"description" : "The postal region definition for Brazil.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for Brazil.",
"enum" : [ "BRA" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "BRAZIL" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "BR-AC", "BR-AL", "BR-AM", "BR-AP", "BR-BA", "BR-CE", "BR-DF", "BR-ES", "BR-GO", "BR-MA", "BR-MG", "BR-MS", "BR-MT", "BR-PA", "BR-PB", "BR-PE", "BR-PI", "BR-PR", "BR-RJ", "BR-RN", "BR-RO", "BR-RR", "BR-RS", "BR-SC", "BR-SE", "BR-SP", "BR-TO" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^\\d{5}\\-\\d{3}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Canada",
"description" : "The postal region definition for Canada.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for Canada.",
"enum" : [ "CAN" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "CANADA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "CA-AB", "CA-BC", "CA-MB", "CA-NB", "CA-NL", "CA-NS", "CA-NT", "CA-NU", "CA-ON", "CA-PE", "CA-QC", "CA-SK", "CA-YT" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(?!.*[DFIOQU])[A-VXY][0-9][A-Z] ?[0-9][A-Z][0-9]$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Mexico",
"description" : "The postal region definition for Mexico.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for Mexico.",
"enum" : [ "MEX" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "MEXICO" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "MX-AGU", "MX-BCN", "MX-BCS", "MX-CAM", "MX-COA", "MX-COL", "MX-CHP", "MX-CHH", "MX-DIF", "MX-DUR", "MX-GUA", "MX-GRO", "MX-HID", "MX-JAL", "MX-MEX", "MX-MIC", "MX-MOR", "MX-NAY", "MX-NLE", "MX-OAX", "MX-PUE", "MX-QUE", "MX-ROO", "MX-SLP", "MX-SIN", "MX-SON", "MX-TAB", "MX-TAM", "MX-TLA", "MX-VER", "MX-YUC", "MX-ZAC" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^\\A\\d{5,5}\\Z$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Netherlands",
"description" : "The postal region definition for the Netherlands.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for the Netherlands.",
"enum" : [ "NLD" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "NETHERLANDS" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "NL-DR", "NL-FL", "NL-FR", "NL-GE", "NL-GR", "NL-LI", "NL-NB", "NL-NH", "NL-OV", "NL-UT", "NL-ZE", "NL-ZH" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(NL-)?(\\d{4})\\s*([A-Z]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "United Kingdom of Great Britain and Northern Ireland",
"description" : "The postal region definition for the United Kingdom of Great Britain and Northern Ireland.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code for the United Kingdom of Great Britain and Northern Ireland.",
"enum" : [ "GBR" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "UNITED KINGDOM OF GREAT BRITAIN AND NORTHERN IRELAND" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"enum" : [ "GB-ENG", "GB-NIR", "GB-SCT", "GB-WLS" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the sub-region within the country.",
"enum" : [ "GB-BAS", "GB-BBD", "GB-BDF", "GB-BDG", "GB-BEN", "GB-BEX", "GB-BIR", "GB-BKM", "GB-BMH", "GB-BNE", "GB-BNH", "GB-BNS", "GB-BOL", "GB-BPL", "GB-BRC", "GB-BRD", "GB-BRY", "GB-BST", "GB-BUR", "GB-CAM", "GB-CBF", "GB-CHE", "GB-CHW", "GB-CLD", "GB-CMA", "GB-CMD", "GB-CON", "GB-COV", "GB-CRY", "GB-DAL", "GB-DBY", "GB-DER", "GB-DEV", "GB-DNC", "GB-DOR", "GB-DUD", "GB-DUR", "GB-EAL", "GB-ENF", "GB-ERY", "GB-ESS", "GB-ESX", "GB-GAT", "GB-GLS", "GB-GRE", "GB-HAL", "GB-HAM", "GB-HAV", "GB-HCK", "GB-HEF", "GB-HIL", "GB-HMF", "GB-HNS", "GB-HPL", "GB-HRT", "GB-HRW", "GB-HRY", "GB-IOS", "GB-IOW", "GB-ISL", "GB-KEC", "GB-KEN", "GB-KHL", "GB-KIR", "GB-KTT", "GB-KWL", "GB-LAN", "GB-LBH", "GB-LCE", "GB-LDS", "GB-LEC", "GB-LEW", "GB-LIN", "GB-LIV", "GB-LND", "GB-LUT", "GB-MAN", "GB-MDB", "GB-MDW", "GB-MIK", "GB-MRT", "GB-NBL", "GB-NEL", "GB-NET", "GB-NFK", "GB-NGM", "GB-NLN", "GB-NSM", "GB-NTH", "GB-NTT", "GB-NTY", "GB-NWM", "GB-NYK", "GB-OLD", "GB-OXF", "GB-PLY", "GB-POL", "GB-POR", "GB-PTE", "GB-RCC", "GB-RCH", "GB-RDB", "GB-RDG", "GB-RIC", "GB-ROT", "GB-RUT", "GB-SAW", "GB-SFK", "GB-SFT", "GB-SGC", "GB-SHF", "GB-SHN", "GB-SHR", "GB-SKP", "GB-SLF", "GB-SLG", "GB-SND", "GB-SOL", "GB-SOM", "GB-SOS", "GB-SRY", "GB-STE", "GB-STH", "GB-STN", "GB-STS", "GB-STT", "GB-STY", "GB-SWD", "GB-SWK", "GB-TAM", "GB-TFW", "GB-THR", "GB-TOB", "GB-TRF", "GB-TWH", "GB-WAR", "GB-WBK", "GB-WFT", "GB-WGN", "GB-WIL", "GB-WKF", "GB-WLL", "GB-WLV", "GB-WND", "GB-WNM", "GB-WOK", "GB-WOR", "GB-WRL", "GB-WRT", "GB-WSM", "GB-WSX", "GB-YOR", "GB-ABC", "GB-AND", "GB-ANN", "GB-BFS", "GB-CCG", "GB-DRS", "GB-FMO", "GB-LBC", "GB-MEA", "GB-MUL", "GB-NMD", "GB-ABD", "GB-ABE", "GB-AGB", "GB-ANS", "GB-CLK", "GB-DGY", "GB-DND", "GB-EAY", "GB-EDH", "GB-EDU", "GB-ELN", "GB-ELS", "GB-ERW", "GB-FAL", "GB-FIF", "GB-GLG", "GB-HLD", "GB-IVC", "GB-MLN", "GB-MRY", "GB-NAY", "GB-NLK", "GB-ORK", "GB-PKN", "GB-RFW", "GB-SAY", "GB-SCB", "GB-SLK", "GB-STG", "GB-WDU", "GB-WLN", "GB-ZET", "GB-AGY", "GB-BGE", "GB-BGW", "GB-CAY", "GB-CGN", "GB-CMN", "GB-CRF", "GB-CWY", "GB-DEN", "GB-FLN", "GB-GWN", "GB-MON", "GB-MTY", "GB-NTL", "GB-NWP", "GB-PEM", "GB-POW", "GB-RCT", "GB-SWA", "GB-TOF", "GB-VGL", "GB-WRX" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(GIR 0AA)|((([A-Z-[QVX]][0-9][0-9]?)|(([A-Z-[QVX]][A-Z-[IJZ]][0-9][0-9]?)|(([A-Z-[QVX]][0-9][A-HJKPSTUW])|([A-Z-[QVX]][A-Z-[IJZ]][0-9][ABEHMNPRVWXY])))) [0-9][A-Z-[CIKMOV]]{2})$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "United States of America",
"description" : "The postal region definition for the United States of America.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code the United States of America.",
"enum" : [ "USA" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"oneOf" : [ {
"type" : "string",
"enum" : [ "UNITED STATES OF AMERICA" ]
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"oneOf" : [ {
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country, if it exists, or the postal code for the region.",
"enum" : [ "US-AL", "US-AK", "US-AZ", "US-AR", "US-CA", "US-CO", "US-CT", "US-DE", "US-DC", "US-FL", "US-GA", "US-HI", "US-ID", "US-IL", "US-IN", "US-IA", "US-KS", "US-KY", "US-LA", "US-ME", "US-MD", "US-MA", "US-MI", "US-MN", "US-MS", "US-MO", "US-MT", "US-NE", "US-NV", "US-NH", "US-NJ", "US-NM", "US-NY", "US-NC", "US-ND", "US-OH", "US-OK", "US-OR", "US-PA", "US-RI", "US-SC", "US-SD", "US-TN", "US-TX", "US-UT", "US-VT", "US-VA", "US-WA", "US-WV", "US-WI", "US-WY", "US-AS", "US-GU", "US-MP", "US-PR", "US-UM", "US-VI", "US-FM", "US-MH", "US-PW", "US-AA", "US-AE", "US-AP" ],
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(\\d{5}(-\\d{4})?|[A-Z]\\d[A-Z] *\\d[A-Z]\\d)$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"deliveryPoint" : {
"title" : "Delivery Point",
"description" : "A specific set of digits between 00 and 99 assigned to every address. When combined with the ZIP + 4 code, the delivery point provides a unique identifier for every deliverable address served by the US Postal Service.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^[0-9][0-9]$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"carrierRoute" : {
"title" : "Carrier Route",
"description" : "A subdivision of a US zipcode.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^(C|R|P)[0-9]{3}$"
}, {
"type" : "string",
"maxLength" : 0
} ]
},
"correctionDigit" : {
"title" : "Correction Digit",
"description" : "A number used to check for errors in a US ZIP code, delivery point, or carrier route.",
"oneOf" : [ {
"type" : "string",
"pattern" : "^[0-9]$"
}, {
"type" : "string",
"maxLength" : 0
} ]
}
},
"additionalProperties" : false,
"required" : [ "code" ]
}, {
"title" : "Generic",
"description" : "The postal region definition for all other counties.",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-1 alpha-3 country code.",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE" ],
"type" : "string"
},
"title" : {
"title" : "Country",
"description" : "The name of the country, as used in everyday speech.",
"type" : "string"
},
"postalTitle" : {
"title" : "Postal Country",
"description" : "The name of the country when mail is being addressed from an international sender.",
"type" : "string"
},
"region" : {
"title" : "Region",
"description" : "A region within the country",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "The ISO 3166-2 code used to identify the region within the country.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The full name of the region",
"type" : "string"
}
},
"additionalProperties" : false
},
"subRegion" : {
"title" : "Subregion",
"description" : "A subregion within the country and region",
"type" : "object",
"properties" : {
"code" : {
"title" : "Code",
"description" : "A code that may be used to identify the sub-region. This should be the ISO 3166-2 code, if one exists, otherwise, a user defined code may be optionally specified.",
"type" : "string"
},
"title" : {
"title" : "Title",
"description" : "The name of a subregion",
"type" : "string"
}
},
"additionalProperties" : false
},
"locality" : {
"title" : "city",
"description" : "The name of the city or town.",
"type" : "string"
},
"postalCode" : {
"title" : "Postal Code",
"description" : "The mailing postal code.",
"type" : "string"
}
},
"additionalProperties" : false,
"required" : [ "code" ]
} ]
}
},
"additionalProperties" : false,
"required" : [ "country" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"additionalProperties" : false
},
"status" : {
"title" : "Status",
"description" : "The status of the payment transaction.",
"enum" : [ "reconciled", "outstanding", "void" ],
"type" : "string"
},
"void" : {
"title" : "Void",
"description" : "The void type and date associated with the transaction.",
"oneOf" : [ {
"type" : "object",
"properties" : {
"type" : {
"title" : "Type",
"description" : "The void type of the transaction.",
"enum" : [ "payableReestablished", "payableNotReestablished" ],
"type" : "string"
},
"date" : {
"title" : "Date",
"description" : "The date the transaction was voided.",
"type" : "string",
"format" : "date",
"pattern" : "^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])$"
}
},
"additionalProperties" : false,
"required" : [ "type", "date" ]
}, {
"type" : "object",
"maxProperties" : 0
} ]
}
},
"required" : [ "id", "documentNumber", "paymentMethod", "paymentDate", "amount", "status" ],
"additionalProperties" : false,
"links" : [ {
"rel" : "namedQuery",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?document={\"document\":{\"type\":$type,\"id\":$id}}",
"name" : "document",
"title" : "Document",
"description" : "Filter to return payment transactions by document type and ID.",
"schema" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "invoice", "refund" ]
},
"id" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
},
"required" : [ "type", "id" ]
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?criteria={\"documentNumber\": {$documentNumber}}",
"title" : "Document Number",
"description" : "The document number associated with the payment transaction (i.e. check number, payment transaction number).",
"schema" : {
"type" : "object",
"properties" : {
"documentNumber" : {
"type" : "string"
}
}
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?criteria={\"paymentsFor\":[{\"document\":{\"referenceDocument\":{\"purchaseOrder\": {\"id\": $id}}}}]}",
"title" : "Payments For Invoice Reference Document",
"description" : "The originating purchase order associated with the invoice.",
"schema" : {
"type" : "object",
"properties" : {
"paymentsFor" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"referenceDocument" : {
"type" : "object",
"properties" : {
"purchaseOrder" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?criteria={\"paymentsFor\":[{\"document\":{\"referenceDocument\":{\"blanketPurchaseOrder\": {\"id\": $id}}}}]}",
"title" : "Payments For Invoice Reference Document",
"description" : "The originating blanket purchase order associated with the invoice.",
"schema" : {
"type" : "object",
"properties" : {
"paymentsFor" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"referenceDocument" : {
"type" : "object",
"properties" : {
"blanketPurchaseOrder" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?criteria={\"paymentsFor\":[{\"document\":{\"referenceDocument\":{\"recurringVoucher\": {\"id\": $id}}}}]}",
"title" : "Payments For Invoice Reference Document",
"description" : "The originating recurring voucher associated with the invoice.",
"schema" : {
"type" : "object",
"properties" : {
"paymentsFor" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"referenceDocument" : {
"type" : "object",
"properties" : {
"recurringVoucher" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
}, {
"rel" : "filter",
"encType" : "application/x-www-form-urlencoded",
"method" : "GET",
"href" : "/payment-transactions?criteria={\"paymentsFor\":[{\"document\":{\"referenceDocument\":{\"purchasingArrangement\": {\"id\": $id}}}}]}",
"title" : "Payments For Invoice Reference Document",
"description" : "The originating purchasing arrangement associated with the invoice.",
"schema" : {
"type" : "object",
"properties" : {
"paymentsFor" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"referenceDocument" : {
"type" : "object",
"properties" : {
"purchasingArrangement" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "guid",
"pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
}
}
}
}
}
}
}
}
}
}
}
},
"targetSchema" : {
"$ref" : "payment-transactions.json#"
}
} ]
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy