Update Payment

v1.0.0

Update Payment

Input

{
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The code assigned to the account."
        },
        "id": {
          "type": "string",
          "description": "The unique identifier for the account."
        },
        "name": {
          "type": "string",
          "description": "The name of the account."
        },
        "nominal_code": {
          "type": "string",
          "description": "The nominal code of the account."
        }
      }
    },
    "accounts_receivable_account_id": {
      "type": "string",
      "description": "Unique identifier for the account to allocate payment to."
    },
    "accounts_receivable_account_type": {
      "type": "string",
      "description": "Type of accounts receivable account."
    },
    "allocations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "description": "Amount of payment that should be attributed to this allocation. If null, the total_amount will be used."
          },
          "code": {
            "type": "string"
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of entity this payment should be attributed to."
          },
          "type": {
            "type": "string",
            "description": "Type of entity this payment should be attributed to.",
            "enum": [
              "invoice",
              "order",
              "expense",
              "credit_memo",
              "over_payment",
              "pre_payment"
            ]
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the object was created."
    },
    "created_by": {
      "type": "string",
      "description": "The user who created the object."
    },
    "currency": {
      "type": "string",
      "description": "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).",
      "enum": [
        "UNKNOWN_CURRENCY",
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SOS",
        "SRD",
        "SSP",
        "STD",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRC",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "USS",
        "UYI",
        "UYU",
        "UZS",
        "VEF",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XTS",
        "XXX",
        "YER",
        "ZAR",
        "ZMK",
        "ZMW",
        "BTC",
        "ETH"
      ]
    },
    "currency_rate": {
      "type": "number",
      "description": "Currency Exchange Rate at the time entity was recorded/generated."
    },
    "customer": {
      "type": "object",
      "description": "The customer this entity is linked to.",
      "required": [
        "id"
      ],
      "properties": {
        "company_name": {
          "type": "string",
          "description": "The company name of the customer."
        },
        "display_id": {
          "type": "string",
          "description": "The display ID of the customer."
        },
        "display_name": {
          "type": "string",
          "description": "The display name of the customer."
        },
        "id": {
          "type": "string",
          "description": "The ID of the customer this entity is linked to."
        },
        "name": {
          "type": "string",
          "description": "The name of the customer. Deprecated, use display_name instead."
        }
      }
    },
    "display_id": {
      "type": "string",
      "description": "Payment id to be displayed."
    },
    "downstream_id": {
      "type": "string",
      "description": "The third-party API ID of original entity"
    },
    "id": {
      "type": "string"
    },
    "note": {
      "type": "string",
      "description": "Optional note to be associated with the payment."
    },
    "payment_method": {
      "type": "string",
      "description": "Payment method name"
    },
    "payment_method_id": {
      "type": "string",
      "description": "Unique identifier for the payment method."
    },
    "payment_method_reference": {
      "type": "string",
      "description": "Optional reference message returned by payment method on processing"
    },
    "raw": {
      "type": "boolean"
    },
    "reconciled": {
      "type": "boolean",
      "description": "Payment has been reconciled"
    },
    "reference": {
      "type": "string",
      "description": "Optional payment reference message ie: Debit remittance detail."
    },
    "row_version": {
      "type": "string",
      "description": "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object."
    },
    "status": {
      "type": "string",
      "description": "Status of payment",
      "enum": [
        "authorised",
        "paid",
        "voided",
        "deleted"
      ]
    },
    "supplier": {
      "type": "object",
      "description": "The supplier this entity is linked to.",
      "required": [
        "id"
      ],
      "properties": {
        "address": {
          "type": "object",
          "properties": {
            "city": {
              "type": "string",
              "description": "Name of city."
            },
            "contact_name": {
              "type": "string"
            },
            "country": {
              "type": "string",
              "description": "country code according to ISO 3166-1 alpha-2."
            },
            "county": {
              "type": "string",
              "description": "Address field that holds a sublocality, such as a county"
            },
            "email": {
              "type": "string"
            },
            "fax": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "latitude": {
              "type": "string"
            },
            "line1": {
              "type": "string",
              "description": "Line 1 of the address e.g. number, street, suite, apt #, etc."
            },
            "line2": {
              "type": "string",
              "description": "Line 2 of the address"
            },
            "line3": {
              "type": "string",
              "description": "Line 3 of the address"
            },
            "line4": {
              "type": "string",
              "description": "Line 4 of the address"
            },
            "longitude": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "phone_number": {
              "type": "string"
            },
            "postal_code": {
              "type": "string",
              "description": "Zip code or equivalent."
            },
            "row_version": {
              "type": "string",
              "description": "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object."
            },
            "salutation": {
              "type": "string"
            },
            "state": {
              "type": "string",
              "description": "Name of state"
            },
            "street_number": {
              "type": "string",
              "description": "Street number"
            },
            "string": {
              "type": "string"
            },
            "type": {
              "type": "string",
              "enum": [
                "primary",
                "secondary",
                "home",
                "office",
                "shipping",
                "billing",
                "other"
              ]
            },
            "website": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "company_name": {
          "type": "string",
          "description": "The company name of the supplier."
        },
        "display_name": {
          "type": "string",
          "description": "The display name of the supplier."
        },
        "id": {
          "type": "string",
          "description": "The ID of the supplier this entity is linked to."
        }
      }
    },
    "total_amount": {
      "type": "number",
      "description": "Amount of payment"
    },
    "transaction_date": {
      "type": "string",
      "format": "date-time",
      "description": "Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD"
    },
    "type": {
      "type": "string",
      "description": "Type of payment",
      "enum": [
        "accounts_receivable",
        "accounts_payable",
        "accounts_receivable_credit",
        "accounts_payable_credit",
        "accounts_receivable_overpayment",
        "accounts_payable_overpayment",
        "accounts_receivable_prepayment",
        "accounts_payable_prepayment"
      ]
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the object was last updated."
    },
    "updated_by": {
      "type": "string",
      "description": "The user who last updated the object."
    },
    "x-apideck-app-id": {
      "type": "string"
    },
    "x-apideck-consumer-id": {
      "type": "string"
    },
    "x-apideck-service-id": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "total_amount",
    "transaction_date",
    "x-apideck-app-id",
    "x-apideck-consumer-id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "data",
    "operation",
    "resource",
    "service",
    "status",
    "status_code"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier of the resource"
        }
      }
    },
    "operation": {
      "type": "string",
      "description": "Operation performed"
    },
    "resource": {
      "type": "string",
      "description": "Unified API resource name"
    },
    "service": {
      "type": "string",
      "description": "Apideck ID of service provider"
    },
    "status": {
      "type": "string",
      "description": "HTTP Response Status"
    },
    "status_code": {
      "type": "integer",
      "description": "HTTP Response Status Code"
    }
  }
}