CampusAPI Payment Services API documentation version 0.1.0
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "customer", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePayerType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePayerType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePayerType%40campusapi.org

• fromDate: (string)

  Get all payers from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all payers up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• resourceId: (string)

  the id string to match a resource.

  Example:

  resource.Resource%3A320%40base.url

• customerId: (string)

  Id string to match customer.

  Example:

  billing.Customer%3A6704%40base.url

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• businessId: (string)

  specify in which business to create this payer

  Example:

  payment.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Payer",
  "type": "object",
  "required": ["resourceId"],
  "properties": {
    "id": {
      "description": "The unique id of this payer. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this payer. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this payer for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this payer.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this payer. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this payer. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this payer.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this payer.",
      "type": "string",
      "format": "date-time"
    },
    "resourceId": {
      "description": "The resource associated with this payer.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerId": {
      "description": "The customer.",
      "type": "string",
      "format": "osid-id"
    },
    "usesActivity": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "usesCash": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "creditCardNumber": {
      "description": "The credit card number.",
      "type": "string"
    },
    "creditCardExpiration": {
      "description": "The credit card expiration date.",
      "type": "string",
      "format": "date-time"
    },
    "creditCardCode": {
      "description": "The credit card security code.",
      "type": "string"
    },
    "bankRoutingNumber": {
      "description": "The bank routing number.",
      "type": "string"
    },
    "bankAccountNumber": {
      "description": "The bank account number.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Payer",
  "description": "The description of this Payer",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "resourceId": "resource.Resource:9198@base.url",
  "customerId": "billing.Customer:8499@base.url",
  "usesActivity": true,
  "usesCash": true,
  "creditCardNumber": "101",
  "creditCardExpiration": "2021-07-21T23:15:30.000Z",
  "creditCardCode": "This is the string for CreditCardCode",
  "bankRoutingNumber": "101",
  "bankAccountNumber": "101"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "customer", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PayerQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match payer that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchCustomerIds": {
      "description": "List of Customer Ids for this query to match customer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customerId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "customerQueries": {
      "description": "billing.CustomerQueries to match the Customer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "customer-query"
      }
    },
    "matchAnyCustomer": {
      "description": "Match customer with any value. true to match Payers with any customer, false to match Payers with no customer",
      "type": "boolean"
    },
    "matchUsesActivity": {
      "description": "Match boolean value for usesActivity.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchUsesCash": {
      "description": "Match boolean value for usesCash.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchCreditCardNumber": {
      "description": "List of CreditCardNumber strings to match. Boolean OR performed among multiple creditCardNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditCardNumbers": {
            "description": "creditCardNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardNumber": {
      "description": "Match creditCardNumbers with any value. true to match Payers with any credit card number, false to match ProgramOfferings with no credit card number",
      "type": "boolean"
    },
    "matchCreditCardExpiration": {
      "description": "Matches creditCardExpirations between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardExpiration": {
      "description": "Match creditCardExpirations with any value. true to match Payers with any credit card expiration, false to match ProgramOfferings with no credit card expiration",
      "type": "boolean"
    },
    "matchCreditCardCode": {
      "description": "List of CreditCardCode strings to match. Boolean OR performed among multiple creditCardCodes.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditCardCodes": {
            "description": "creditCardCodes to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardCode": {
      "description": "Match creditCardCodes with any value. true to match Payers with any credit card code, false to match ProgramOfferings with no credit card code",
      "type": "boolean"
    },
    "matchBankRoutingNumber": {
      "description": "List of BankRoutingNumber strings to match. Boolean OR performed among multiple bankRoutingNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankRoutingNumbers": {
            "description": "bankRoutingNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyBankRoutingNumber": {
      "description": "Match bankRoutingNumbers with any value. true to match Payers with any bank routing number, false to match ProgramOfferings with no bank routing number",
      "type": "boolean"
    },
    "matchBankAccountNumber": {
      "description": "List of BankAccountNumber strings to match. Boolean OR performed among multiple bankAccountNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankAccountNumbers": {
            "description": "bankAccountNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyBankAccountNumber": {
      "description": "Match bankAccountNumbers with any value. true to match Payers with any bank account number, false to match ProgramOfferings with no bank account number",
      "type": "boolean"
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "business-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• businessId: (string)

  specify in which business to create this payer

  Example:

  payment.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "PayerBatch",
    "type": "array",
    "Items": {
        "type": "payer"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Payer",
    "description": "The description of this Payer",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "customerId": "billing.Customer:8979@base.url",
    "usesActivity": true,
    "usesCash": true,
    "creditCardNumber": "101",
    "creditCardExpiration": "2021-07-21T23:15:30.000Z",
    "creditCardCode": "This is the string for CreditCardCode",
    "bankRoutingNumber": "101",
    "bankAccountNumber": "101"
  },
  {
    "...": "..."
  }
]

Query Parameters

• resourceId: required(string)

  the resource of this metadatum.

  Example:

  resource.Resource%3A320%40base.url

• genusType: (string)

  specify a particular payer type to create

  Example:

  type.Type%3AexamplePayerType%40dxtera.org

• recordType: (array of )

  specify support for one or more payer record types

  Example:

  [
    "type.Type%3AexamplePayerRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this payer

  Example:

  payment.Business%3A8374%40base.url

URI Parameters

• payerId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "customer", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• payerId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PayerItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this payer. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this payer. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this payer for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this payer.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this payer. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this payer. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this payer.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this payer.",
      "type": "string",
      "format": "date-time"
    },
    "resourceId": {
      "description": "The resource associated with this payer.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerId": {
      "description": "The customer.",
      "type": "string",
      "format": "osid-id"
    },
    "usesActivity": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "usesCash": {
      "description": "-- could someone please write a description for this --",
      "type": "boolean"
    },
    "creditCardNumber": {
      "description": "The credit card number.",
      "type": "string"
    },
    "creditCardExpiration": {
      "description": "The credit card expiration date.",
      "type": "string",
      "format": "date-time"
    },
    "creditCardCode": {
      "description": "The credit card security code.",
      "type": "string"
    },
    "bankRoutingNumber": {
      "description": "The bank routing number.",
      "type": "string"
    },
    "bankAccountNumber": {
      "description": "The bank account number.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Payer",
  "description": "The description of this Payer",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "customerId": "billing.Customer:5976@base.url",
  "usesActivity": true,
  "usesCash": true,
  "creditCardNumber": "101",
  "creditCardExpiration": "2021-07-21T23:15:30.000Z",
  "creditCardCode": "This is the string for CreditCardCode",
  "bankRoutingNumber": "101",
  "bankAccountNumber": "101"
}

URI Parameters

• payerId: required(string)

URI Parameters

• payerId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "period", "payer", "customer", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePaymentType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePaymentType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePaymentType%40campusapi.org

• payerId: (string)

  the id string to match a payer.

  Example:

  payment.Payer%3A245%40base.url

• customerId: (string)

  the id string to match a customer.

  Example:

  billing.Customer%3A392%40base.url

• fromDate: (string)

  Get all payments from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all payments up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• businessId: (string)

  The id string to match a business

  Example:

  billing.Business%3A8374%40base.url

Query Parameters

• businessId: (string)

  specify in which business to create this payment

  Example:

  payment.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Payment",
  "type": "object",
  "required": ["payerId", "customerId"],
  "properties": {
    "id": {
      "description": "The unique id of this payment. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this payment. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this payment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this payment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this payment. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this payment. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "payerId": {
      "description": "The payer associated with this payment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerId": {
      "description": "The customer associated with this payment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "periodId": {
      "description": "The billing period to which this payment applied.",
      "type": "string",
      "format": "osid-id"
    },
    "paymentDate": {
      "description": "The date the payment was made.",
      "type": "string",
      "format": "date-time"
    },
    "processDate": {
      "description": "The date the payment was or will be processed.",
      "type": "string",
      "format": "date-time"
    },
    "amount": {
      "description": "The amount of this payment.",
      "type": "string",
      "format": "currency"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Payment",
  "description": "The description of this Payment",
  "payerId": "billing.payment.Payer:9029@base.url",
  "customerId": "billing.Customer:4183@base.url",
  "periodId": "billing.Period:1501@base.url",
  "paymentDate": "2021-07-21T23:15:30.000Z",
  "processDate": "2021-07-21T23:15:30.000Z",
  "amount": "USD+42.00"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "period", "payer", "customer", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PaymentQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchPayerIds": {
      "description": "List of payer Ids for this query to match payment that have a related payer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "payerQueries": {
      "description": "PayerQueries to match the payer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "payer-query"
      }
    },
    "matchCustomerIds": {
      "description": "List of customer Ids for this query to match payment that have a related customer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "customerQueries": {
      "description": "CustomerQueries to match the customer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "customer-query"
      }
    },
    "matchPeriodIds": {
      "description": "List of Period Ids for this query to match period.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "periodId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "periodQueries": {
      "description": "billing.PeriodQueries to match the Period. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "period-query"
      }
    },
    "matchAnyPeriod": {
      "description": "Match period with any value. true to match Payments with any period, false to match Payments with no period",
      "type": "boolean"
    },
    "matchPaymentDate": {
      "description": "Matches paymentDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPaymentDate": {
      "description": "Match paymentDates with any value. true to match Payments with any payment date, false to match ProgramOfferings with no payment date",
      "type": "boolean"
    },
    "matchProcessDate": {
      "description": "Matches processDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyProcessDate": {
      "description": "Match processDates with any value. true to match Payments with any process date, false to match ProgramOfferings with no process date",
      "type": "boolean"
    },
    "matchAmount": {
      "description": "Matches amounts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyAmount": {
      "description": "Match amounts with any value. true to match Payments with any amount, false to match ProgramOfferings with no amount",
      "type": "boolean"
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "business-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• businessId: (string)

  specify in which business to create this payment

  Example:

  payment.Business%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "PaymentBatch",
    "type": "array",
    "Items": {
        "type": "payment"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Payment",
    "description": "The description of this Payment",
    "periodId": "billing.Period:7507@base.url",
    "paymentDate": "2021-07-21T23:15:30.000Z",
    "processDate": "2021-07-21T23:15:30.000Z",
    "amount": "USD+42.00"
  },
  {
    "...": "..."
  }
]

Query Parameters

• payerId: required(string)

  the payer of this metadatum.

  Example:

  payment.Payer%3A245%40base.url

• customerId: required(string)

  the customer of this metadatum.

  Example:

  billing.Customer%3A392%40base.url

• genusType: (string)

  specify a particular payment type to create

  Example:

  type.Type%3AexamplePaymentType%40dxtera.org

• recordType: (array of )

  specify support for one or more payment record types

  Example:

  [
    "type.Type%3AexamplePaymentRecordType%40campusapi.org",
    "..."
  ]

• businessId: (string)

  specify in which business to create this payment

  Example:

  payment.Business%3A8374%40base.url

URI Parameters

• paymentId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "period", "payer", "customer", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• paymentId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PaymentItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this payment. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this payment. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this payment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this payment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this payment. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this payment. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "payerId": {
      "description": "The payer associated with this payment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "customerId": {
      "description": "The customer associated with this payment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "periodId": {
      "description": "The billing period to which this payment applied.",
      "type": "string",
      "format": "osid-id"
    },
    "paymentDate": {
      "description": "The date the payment was made.",
      "type": "string",
      "format": "date-time"
    },
    "processDate": {
      "description": "The date the payment was or will be processed.",
      "type": "string",
      "format": "date-time"
    },
    "amount": {
      "description": "The amount of this payment.",
      "type": "string",
      "format": "currency"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Payment",
  "description": "The description of this Payment",
  "periodId": "billing.Period:239@base.url",
  "paymentDate": "2021-07-21T23:15:30.000Z",
  "processDate": "2021-07-21T23:15:30.000Z",
  "amount": "USD+42.00"
}

URI Parameters

• paymentId: required(string)

URI Parameters

• paymentId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleBusinessType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleBusinessType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleBusinessType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• payerId: (string)

  Get businesses mapped to this payer.

  Example:

  payment.Payer%3A280%40demo.dxtera.org

• paymentId: (string)

  Get businesses mapped to this payment.

  Example:

  payment.Payment%3A392%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular business type to create

  Example:

  type.Type%3AexampleBusinessType%40dxtera.org

• recordType: (array of )

  specify support for one or more business record types

  Example:

  [
    "type.Type%3AexampleBusinessRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Business",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this business. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this business.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this business. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Business",
  "description": "The description of this Business",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Business@base.url",
  "license": "The license that applies to this Business"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BusinessQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "providerQueries": {
      "description": "providerQueries to match the provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Business with any provider, false to match Business with no provider",
      "type": "boolean"
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQueries to match the branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "asset-query"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Business with any branding, false to match Business with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "business-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "$schema": "http://json-schema.org/draft/2019-9/schema#",
  "title": "Business",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this business, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this business",
      "linked": false
    },
    "description": {
      "description": "The description of this business.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this business",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter on initial post.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this business",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this business. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Business.Business:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this business",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Business.Business:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this business",
      "linked": false
    }
  }
}

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• childId: required(string)

URI Parameters

• childId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• businessId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BusinessItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this business. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this business. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this business for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this business.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this business. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this business. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this business.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this business. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this business.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Business",
  "description": "The description of this Business",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Business@base.url",
  "license": "The license that applies to this Business"
}

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "customer", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePayerType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePayerType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePayerType%40campusapi.org

URI Parameters

• businessId: required(string)
• payerId: required(string)

URI Parameters

• businessId: required(string)
• payerId: required(string)

URI Parameters

• businessId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PayerQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match payer that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchCustomerIds": {
      "description": "List of Customer Ids for this query to match customer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customerId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "customerQueries": {
      "description": "billing.CustomerQueries to match the Customer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "customer-query"
      }
    },
    "matchAnyCustomer": {
      "description": "Match customer with any value. true to match Payers with any customer, false to match Payers with no customer",
      "type": "boolean"
    },
    "matchUsesActivity": {
      "description": "Match boolean value for usesActivity.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchUsesCash": {
      "description": "Match boolean value for usesCash.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchCreditCardNumber": {
      "description": "List of CreditCardNumber strings to match. Boolean OR performed among multiple creditCardNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditCardNumbers": {
            "description": "creditCardNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardNumber": {
      "description": "Match creditCardNumbers with any value. true to match Payers with any credit card number, false to match ProgramOfferings with no credit card number",
      "type": "boolean"
    },
    "matchCreditCardExpiration": {
      "description": "Matches creditCardExpirations between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardExpiration": {
      "description": "Match creditCardExpirations with any value. true to match Payers with any credit card expiration, false to match ProgramOfferings with no credit card expiration",
      "type": "boolean"
    },
    "matchCreditCardCode": {
      "description": "List of CreditCardCode strings to match. Boolean OR performed among multiple creditCardCodes.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "creditCardCodes": {
            "description": "creditCardCodes to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCreditCardCode": {
      "description": "Match creditCardCodes with any value. true to match Payers with any credit card code, false to match ProgramOfferings with no credit card code",
      "type": "boolean"
    },
    "matchBankRoutingNumber": {
      "description": "List of BankRoutingNumber strings to match. Boolean OR performed among multiple bankRoutingNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankRoutingNumbers": {
            "description": "bankRoutingNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyBankRoutingNumber": {
      "description": "Match bankRoutingNumbers with any value. true to match Payers with any bank routing number, false to match ProgramOfferings with no bank routing number",
      "type": "boolean"
    },
    "matchBankAccountNumber": {
      "description": "List of BankAccountNumber strings to match. Boolean OR performed among multiple bankAccountNumbers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bankAccountNumbers": {
            "description": "bankAccountNumbers to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyBankAccountNumber": {
      "description": "Match bankAccountNumbers with any value. true to match Payers with any bank account number, false to match ProgramOfferings with no bank account number",
      "type": "boolean"
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "business-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

URI Parameters

• businessId: required(string)

URI Parameters

• businessId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "period", "payer", "customer", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexamplePaymentType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePaymentType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePaymentType%40campusapi.org

URI Parameters

• businessId: required(string)
• paymentId: required(string)

URI Parameters

• businessId: required(string)
• paymentId: required(string)

URI Parameters

• businessId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PaymentQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchPayerIds": {
      "description": "List of payer Ids for this query to match payment that have a related payer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "payerQueries": {
      "description": "PayerQueries to match the payer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "payer-query"
      }
    },
    "matchCustomerIds": {
      "description": "List of customer Ids for this query to match payment that have a related customer.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "customerQueries": {
      "description": "CustomerQueries to match the customer. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "customer-query"
      }
    },
    "matchPeriodIds": {
      "description": "List of Period Ids for this query to match period.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "periodId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "periodQueries": {
      "description": "billing.PeriodQueries to match the Period. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "period-query"
      }
    },
    "matchAnyPeriod": {
      "description": "Match period with any value. true to match Payments with any period, false to match Payments with no period",
      "type": "boolean"
    },
    "matchPaymentDate": {
      "description": "Matches paymentDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyPaymentDate": {
      "description": "Match paymentDates with any value. true to match Payments with any payment date, false to match ProgramOfferings with no payment date",
      "type": "boolean"
    },
    "matchProcessDate": {
      "description": "Matches processDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyProcessDate": {
      "description": "Match processDates with any value. true to match Payments with any process date, false to match ProgramOfferings with no process date",
      "type": "boolean"
    },
    "matchAmount": {
      "description": "Matches amounts in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyAmount": {
      "description": "Match amounts with any value. true to match Payments with any amount, false to match ProgramOfferings with no amount",
      "type": "boolean"
    },
    "matchBusinessIds": {
      "description": "List of Business Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessId": {
            "description": "Business id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "businessQueries": {
      "description": "BusinessQueries to match Business. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "business-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

URI Parameters

• businessId: required(string)