Procurify · Schema

PaymentResponse

Spend ManagementProcurementPurchase OrdersAccounts PayableVendor ManagementBudget TrackingProcure-to-PayERP Integration

Properties

Name	Type	Description
id	integer
uuid	string
payment_source_name	string
payment_source_type	object	* direct_debit: Payment is paid from a direct debit account * financial_account: Payment is paid from a financial account * external: Payment is paid outside of Procurify
external_payment_source_id	integer	External bank account ID
creator	object
created_at	string
updated_at	string
amount	string
currency	object
status	object	* draft: Payment has been created but not yet submitted for approval. * pending_approval: Payment is waiting for approval. * approved: Payment has been approved and is awaiting processing. * denied: P
processing_date	string
direct_debit_bank_account_mask	string	Last 4 digits of direct debit account.
vendor_name	string
posted_date	string
gl_code	string	Payment source's GL code.
vendor_payment_method_country_code	string	ISO 3166 country codes
vendor_payment_method_rail	string	Rails supported: ACH, FEDWIRE, PAPER_CHECK, LOCAL, etc.
bill_groups	array	List of bill group IDs associated with the payment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PaymentResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "uuid": {
      "type": "string"
    },
    "payment_source_name": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "payment_source_type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaymentSourceTypeEnum"
        }
      ],
      "nullable": true,
      "readOnly": true,
      "description": "\n* direct_debit: Payment is paid from a direct debit account\n* financial_account: Payment is paid from a financial account\n* external: Payment is paid outside of Procurify",
      "type": "object"
    },
    "external_payment_source_id": {
      "type": "integer",
      "nullable": true,
      "readOnly": true,
      "description": "External bank account ID"
    },
    "creator": {
      "$ref": "#/components/schemas/PaymentCreator"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "amount": {
      "type": "string",
      "format": "decimal",
      "pattern": "^-?\\d{0,19}(?:\\.\\d{0,2})?$"
    },
    "currency": {
      "$ref": "#/components/schemas/PaymentCurrencyResponse"
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaymentResponseStatusEnum"
        }
      ],
      "nullable": true,
      "readOnly": true,
      "description": "\n* draft: Payment has been created but not yet submitted for approval.\n* pending_approval: Payment is waiting for approval.\n* approved: Payment has been approved and is awaiting processing.\n* denied: Payment has been denied by an approver.\n* paid: Payment has been successfully completed.\n* processing: Payment is currently being processed.\n* failed: Payment processing has failed.\n* scheduled: Payment is scheduled for a future processing date.",
      "type": "object"
    },
    "processing_date": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "direct_debit_bank_account_mask": {
      "type": "string",
      "nullable": true,
      "description": "Last 4 digits of direct debit account."
    },
    "vendor_name": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "posted_date": {
      "type": "string",
      "format": "date",
      "nullable": true
    },
    "gl_code": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Payment source's GL code."
    },
    "vendor_payment_method_country_code": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "ISO 3166 country codes"
    },
    "vendor_payment_method_rail": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Rails supported: ACH, FEDWIRE, PAPER_CHECK, LOCAL, etc."
    },
    "bill_groups": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "readOnly": true,
      "description": "List of bill group IDs associated with the payment."
    }
  },
  "required": [
    "amount",
    "created_at",
    "creator",
    "currency",
    "direct_debit_bank_account_mask",
    "id",
    "posted_date",
    "updated_at",
    "uuid"
  ]
}