v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB

Pay Runs

Get Pay Run Payable Schema

Creates the payable JSON schema for the requested country and currency.

get/pay-runs/payables/schema

Query parameters

Countrystring required

The country of the beneficiary's bank account. This is an ISO 3166-1 alpha-2 code.

Currencystring required

The currency of the beneficiary's bank account. This is an ISO 4217:2015 Alpha-3 currency code.

Headers

Crezco-Versionstring

The requested API version

Response

typestring

titlestring required

A Human readable title of the schema.

descriptionstring required

A Human readable description of the schema.

propertiesobject required

The properties of the schema.

requiredstring[] required

The required properties of the schema.

Example response

{
  "type": "object",
  "title": "Payable",
  "description": "Payable schema",
  "properties": {
    "partnerEntityId": {
      "type": "string"
    },
    "amount": {
      "type": "object",
      "properties": {
        "currencyCode": {
          "type": "string"
        },
        "amountInMinorUnits": {
          "type": "integer"
        }
      },
      "required": [
        "currencyCode",
        "amountInMinorUnits"
      ]
    },
    "beneficiary": {
      "ref": "#/$defs/beneficiary"
    },
    "reference": {
      "type": "string"
    },
    "isLowPriority": {
      "type": "boolean"
    },
    "purposeCode": {
      "ref": "#/$defs/purposeCode"
    },
    "invoice": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "number": {
          "type": [
            "string",
            "null"
          ]
        },
        "date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        }
      },
      "required": []
    }
  },
  "required": [
    "partnerEntityId",
    "amount",
    "beneficiary",
    "reference"
  ],
  "$defs": {
    "beneficiary": {
      "type": "object",
      "oneOf": [
        {
          "type": "object",
          "title": "Individual Beneficiary",
          "description": "Individual Beneficiary",
          "properties": {
            "$type": {
              "const": "Individual"
            },
            "firstName": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "address": {
              "ref": "#/$defs/beneficiaryAddress"
            },
            "bankAccount": {
              "ref": "#/$defs/bankAccount"
            }
          },
          "required": [
            "$type",
            "firstName",
            "lastName",
            "address",
            "bankAccount"
          ]
        },
        {
          "type": "object",
          "title": "Organisation Beneficiary",
          "description": "Organisation Beneficiary",
          "properties": {
            "$type": {
              "const": "Organisation"
            },
            "companyName": {
              "type": "string"
            },
            "address": {
              "ref": "#/$defs/beneficiaryAddress"
            },
            "bankAccount": {
              "ref": "#/$defs/bankAccount"
            }
          },
          "required": [
            "$type",
            "companyName",
            "address",
            "bankAccount"
          ]
        }
      ]
    },
    "beneficiaryAddress": {
      "type": "object",
      "title": "BeneficiaryAddress",
      "description": "Beneficiary address",
      "properties": {
        "street": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "region": {
          "type": [
            "string",
            "null"
          ]
        },
        "country": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "city",
        "country",
        "postalCode"
      ]
    },
    "bankAccount": {
      "type": "object",
      "oneOf": [
        {
          "type": "object",
          "title": "Priority",
          "description": "Priority",
          "properties": {
            "country": {
              "type": "string"
            },
            "accountCurrency": {
              "type": "string"
            },
            "accountRoutingName": {
              "type": "string"
            },
            "auAccountNumber": {
              "type": "string"
            },
            "swiftBic": {
              "type": "string"
            }
          },
          "required": [
            "country",
            "accountCurrency",
            "accountRoutingName",
            "auAccountNumber",
            "swiftBic"
          ]
        }
      ]
    },
    "purposeCode": {
      "title": "Payment Purpose Code",
      "description": "The purpose of the payment",
      "oneOf": [
        {
          "const": "BusinessAndAdvisoryServices",
          "title": "Business & Advisory Services"
        },
        {
          "const": "Construction",
          "title": "Construction"
        },
        {
          "const": "DirectEmployeeSalaries",
          "title": "Direct Employee Salaries"
        },
        {
          "const": "Expenses",
          "title": "Expenses"
        },
        {
          "const": "Insurance",
          "title": "Insurance"
        },
        {
          "const": "IntellectualProperty",
          "title": "Intellectual Property"
        },
        {
          "const": "IntercompanyTransfer",
          "title": "Intercompany Transfer"
        },
        {
          "const": "InvestmentActivity",
          "title": "Investment Activity"
        },
        {
          "const": "PayingForGoods",
          "title": "Paying for Goods"
        },
        {
          "const": "RealEstateAndProperty",
          "title": "Real Estate & Property"
        },
        {
          "const": null
        }
      ],
      "not": {
        "anyOf": []
      }
    }
  }
}