Jump to

• Request
• Response

Update Sync Request

patch

/rest/apis/common/sync/syncRequest/{syncRequestId}

This operation is used when an external system responds to a Sync Request. If the exception messages are provided, they are populated and the BO is transitioned to the exception state. If no exception messages are provided, the BO is transitioned to the default next state.

Request

Path Parameters

• syncRequestId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• C1APChkRest: object C1APChkRest

{
    "type":"object",
    "properties":{
        "C1APChkRest":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "apRequestId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                            "example":"873490693226"
                        },
                        "paymentCurrency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Payment Currency",
                            "example":"USD"
                        },
                        "paidAmount":{
                            "type":"number",
                            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                            "example":"20.00"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                            "example":"2022-07-18"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":36,
                            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                            "example":"873483873762"
                        },
                        "paymentMethod":{
                            "type":"string",
                            "enum":[
                                "CHK "
                            ],
                            "description":"Payment method\n* `CHK ` - System Check",
                            "example":"CHK"
                        },
                        "paymentSelectionStatus":{
                            "type":"string",
                            "enum":[
                                "C   ",
                                "D   ",
                                "H   ",
                                "N   ",
                                "P   ",
                                "R   ",
                                "V   ",
                                "X   "
                            ],
                            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                            "example":"P"
                        },
                        "adjustmentCancelReason":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                        }
                    }
                },
                "errorInformation":{
                    "type":"object",
                    "properties":{
                        "hadError":{
                            "type":"boolean",
                            "description":"An error was encountered"
                        },
                        "errorText":{
                            "type":"string",
                            "maxLength":400,
                            "description":"Error Message"
                        },
                        "messageCategory":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Category"
                        },
                        "messageNumber":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number"
                        },
                        "messageParameters":{
                            "type":"object",
                            "properties":{
                                "parameters":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "parameterType":{
                                                "type":"string",
                                                "enum":[
                                                    "AMT ",
                                                    "DATE",
                                                    "DTTM",
                                                    "DUR ",
                                                    "FLD ",
                                                    "MMDD",
                                                    "MSG ",
                                                    "NBR ",
                                                    "SRVC",
                                                    "TBL ",
                                                    "TIME"
                                                ],
                                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                                "example":"FLD"
                                            },
                                            "parameterValue":{
                                                "type":"string",
                                                "maxLength":2000,
                                                "description":"Message Parameter Value"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : C1APChkRest

Type: object

Show Source

• errorInformation: object errorInformation
• input: object input

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "apRequestId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                    "example":"873490693226"
                },
                "paymentCurrency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Payment Currency",
                    "example":"USD"
                },
                "paidAmount":{
                    "type":"number",
                    "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                    "example":"20.00"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                    "example":"2022-07-18"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                    "example":"873483873762"
                },
                "paymentMethod":{
                    "type":"string",
                    "enum":[
                        "CHK "
                    ],
                    "description":"Payment method\n* `CHK ` - System Check",
                    "example":"CHK"
                },
                "paymentSelectionStatus":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "D   ",
                        "H   ",
                        "N   ",
                        "P   ",
                        "R   ",
                        "V   ",
                        "X   "
                    ],
                    "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                    "example":"P"
                },
                "adjustmentCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                }
            }
        },
        "errorInformation":{
            "type":"object",
            "properties":{
                "hadError":{
                    "type":"boolean",
                    "description":"An error was encountered"
                },
                "errorText":{
                    "type":"string",
                    "maxLength":400,
                    "description":"Error Message"
                },
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Category"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number"
                },
                "messageParameters":{
                    "type":"object",
                    "properties":{
                        "parameters":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "parameterType":{
                                        "type":"string",
                                        "enum":[
                                            "AMT ",
                                            "DATE",
                                            "DTTM",
                                            "DUR ",
                                            "FLD ",
                                            "MMDD",
                                            "MSG ",
                                            "NBR ",
                                            "SRVC",
                                            "TBL ",
                                            "TIME"
                                        ],
                                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                        "example":"FLD"
                                    },
                                    "parameterValue":{
                                        "type":"string",
                                        "maxLength":2000,
                                        "description":"Message Parameter Value"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorText: string
  Maximum Length: 400

  Error Message
• hadError: boolean
  An error was encountered
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: object messageParameters

{
    "type":"object",
    "properties":{
        "hadError":{
            "type":"boolean",
            "description":"An error was encountered"
        },
        "errorText":{
            "type":"string",
            "maxLength":400,
            "description":"Error Message"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number"
        },
        "messageParameters":{
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "parameterType":{
                                "type":"string",
                                "enum":[
                                    "AMT ",
                                    "DATE",
                                    "DTTM",
                                    "DUR ",
                                    "FLD ",
                                    "MMDD",
                                    "MSG ",
                                    "NBR ",
                                    "SRVC",
                                    "TBL ",
                                    "TIME"
                                ],
                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                "example":"FLD"
                            },
                            "parameterValue":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• adjustmentCancelReason: string
  Maximum Length: 4

  Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled.
• apRequestId: string
  Maximum Length: 12

  AP Request ID is the system-assigned, unique identifier of the AP check request.

  Example: 873490693226
• paidAmount: number
  Paid Amount is the amount of the check. This field can be provided after AP cuts the check.

  Example: 20.00
• paymentCurrency: string
  Maximum Length: 3

  Payment Currency

  Example: USD
• paymentDate: string (date)
  Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.

  Example: 2022-07-18
• paymentMethod: string
  Allowed Values: [ "CHK " ]

  Payment method * `CHK ` - System Check

  Example: CHK
• paymentNumber: string
  Maximum Length: 36

  Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.

  Example: 873483873762
• paymentSelectionStatus: string
  Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]

  Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by AP for payment ??? Requested for Payment after it's selected by AP ??? Paid after it's paid by AP ??? Canceled if it's been canceled in AP ??? Hold if it's been held in AP * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled

  Example: P

{
    "type":"object",
    "properties":{
        "apRequestId":{
            "type":"string",
            "maxLength":12,
            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
            "example":"873490693226"
        },
        "paymentCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Payment Currency",
            "example":"USD"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
            "example":"20.00"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
            "example":"2022-07-18"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":36,
            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
            "example":"873483873762"
        },
        "paymentMethod":{
            "type":"string",
            "enum":[
                "CHK "
            ],
            "description":"Payment method\n* `CHK ` - System Check",
            "example":"CHK"
        },
        "paymentSelectionStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "D   ",
                "H   ",
                "N   ",
                "P   ",
                "R   ",
                "V   ",
                "X   "
            ],
            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
            "example":"P"
        },
        "adjustmentCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
        }
    }
}

Nested Schema : messageParameters

Type: object

Show Source

• parameters: array parameters

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterType":{
                        "type":"string",
                        "enum":[
                            "AMT ",
                            "DATE",
                            "DTTM",
                            "DUR ",
                            "FLD ",
                            "MMDD",
                            "MSG ",
                            "NBR ",
                            "SRVC",
                            "TBL ",
                            "TIME"
                        ],
                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                        "example":"FLD"
                    },
                    "parameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterType":{
                "type":"string",
                "enum":[
                    "AMT ",
                    "DATE",
                    "DTTM",
                    "DUR ",
                    "FLD ",
                    "MMDD",
                    "MSG ",
                    "NBR ",
                    "SRVC",
                    "TBL ",
                    "TIME"
                ],
                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                "example":"FLD"
            },
            "parameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• parameterType: string
  Allowed Values: [ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]

  Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameter

  Example: FLD
• parameterValue: string
  Maximum Length: 2000

  Message Parameter Value

{
    "type":"object",
    "properties":{
        "parameterType":{
            "type":"string",
            "enum":[
                "AMT ",
                "DATE",
                "DTTM",
                "DUR ",
                "FLD ",
                "MMDD",
                "MSG ",
                "NBR ",
                "SRVC",
                "TBL ",
                "TIME"
            ],
            "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
            "example":"FLD"
        },
        "parameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter Value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• C1APChkRest: object C1APChkRest

{
    "type":"object",
    "properties":{
        "C1APChkRest":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "apRequestId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                            "example":"873490693226"
                        },
                        "paymentCurrency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Payment Currency",
                            "example":"USD"
                        },
                        "paidAmount":{
                            "type":"number",
                            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                            "example":"20.00"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                            "example":"2022-07-18"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":36,
                            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                            "example":"873483873762"
                        },
                        "paymentMethod":{
                            "type":"string",
                            "enum":[
                                "CHK "
                            ],
                            "description":"Payment method\n* `CHK ` - System Check",
                            "example":"CHK"
                        },
                        "paymentSelectionStatus":{
                            "type":"string",
                            "enum":[
                                "C   ",
                                "D   ",
                                "H   ",
                                "N   ",
                                "P   ",
                                "R   ",
                                "V   ",
                                "X   "
                            ],
                            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                            "example":"P"
                        },
                        "adjustmentCancelReason":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                        }
                    }
                },
                "errorInformation":{
                    "type":"object",
                    "properties":{
                        "hadError":{
                            "type":"boolean",
                            "description":"An error was encountered"
                        },
                        "errorText":{
                            "type":"string",
                            "maxLength":400,
                            "description":"Error Message"
                        },
                        "messageCategory":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Category"
                        },
                        "messageNumber":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number"
                        },
                        "messageParameters":{
                            "type":"object",
                            "properties":{
                                "parameters":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "parameterType":{
                                                "type":"string",
                                                "enum":[
                                                    "AMT ",
                                                    "DATE",
                                                    "DTTM",
                                                    "DUR ",
                                                    "FLD ",
                                                    "MMDD",
                                                    "MSG ",
                                                    "NBR ",
                                                    "SRVC",
                                                    "TBL ",
                                                    "TIME"
                                                ],
                                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                                "example":"FLD"
                                            },
                                            "parameterValue":{
                                                "type":"string",
                                                "maxLength":2000,
                                                "description":"Message Parameter Value"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : C1APChkRest

Type: object

Show Source

• errorInformation: object errorInformation
• input: object input

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "apRequestId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                    "example":"873490693226"
                },
                "paymentCurrency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Payment Currency",
                    "example":"USD"
                },
                "paidAmount":{
                    "type":"number",
                    "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                    "example":"20.00"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                    "example":"2022-07-18"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                    "example":"873483873762"
                },
                "paymentMethod":{
                    "type":"string",
                    "enum":[
                        "CHK "
                    ],
                    "description":"Payment method\n* `CHK ` - System Check",
                    "example":"CHK"
                },
                "paymentSelectionStatus":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "D   ",
                        "H   ",
                        "N   ",
                        "P   ",
                        "R   ",
                        "V   ",
                        "X   "
                    ],
                    "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                    "example":"P"
                },
                "adjustmentCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                }
            }
        },
        "errorInformation":{
            "type":"object",
            "properties":{
                "hadError":{
                    "type":"boolean",
                    "description":"An error was encountered"
                },
                "errorText":{
                    "type":"string",
                    "maxLength":400,
                    "description":"Error Message"
                },
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Category"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number"
                },
                "messageParameters":{
                    "type":"object",
                    "properties":{
                        "parameters":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "parameterType":{
                                        "type":"string",
                                        "enum":[
                                            "AMT ",
                                            "DATE",
                                            "DTTM",
                                            "DUR ",
                                            "FLD ",
                                            "MMDD",
                                            "MSG ",
                                            "NBR ",
                                            "SRVC",
                                            "TBL ",
                                            "TIME"
                                        ],
                                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                        "example":"FLD"
                                    },
                                    "parameterValue":{
                                        "type":"string",
                                        "maxLength":2000,
                                        "description":"Message Parameter Value"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorText: string
  Maximum Length: 400

  Error Message
• hadError: boolean
  An error was encountered
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: object messageParameters

{
    "type":"object",
    "properties":{
        "hadError":{
            "type":"boolean",
            "description":"An error was encountered"
        },
        "errorText":{
            "type":"string",
            "maxLength":400,
            "description":"Error Message"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number"
        },
        "messageParameters":{
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "parameterType":{
                                "type":"string",
                                "enum":[
                                    "AMT ",
                                    "DATE",
                                    "DTTM",
                                    "DUR ",
                                    "FLD ",
                                    "MMDD",
                                    "MSG ",
                                    "NBR ",
                                    "SRVC",
                                    "TBL ",
                                    "TIME"
                                ],
                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                "example":"FLD"
                            },
                            "parameterValue":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• adjustmentCancelReason: string
  Maximum Length: 4

  Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled.
• apRequestId: string
  Maximum Length: 12

  AP Request ID is the system-assigned, unique identifier of the AP check request.

  Example: 873490693226
• paidAmount: number
  Paid Amount is the amount of the check. This field can be provided after AP cuts the check.

  Example: 20.00
• paymentCurrency: string
  Maximum Length: 3

  Payment Currency

  Example: USD
• paymentDate: string (date)
  Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.

  Example: 2022-07-18
• paymentMethod: string
  Allowed Values: [ "CHK " ]

  Payment method * `CHK ` - System Check

  Example: CHK
• paymentNumber: string
  Maximum Length: 36

  Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.

  Example: 873483873762
• paymentSelectionStatus: string
  Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]

  Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by AP for payment ??? Requested for Payment after it's selected by AP ??? Paid after it's paid by AP ??? Canceled if it's been canceled in AP ??? Hold if it's been held in AP * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled

  Example: P

{
    "type":"object",
    "properties":{
        "apRequestId":{
            "type":"string",
            "maxLength":12,
            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
            "example":"873490693226"
        },
        "paymentCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Payment Currency",
            "example":"USD"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
            "example":"20.00"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
            "example":"2022-07-18"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":36,
            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
            "example":"873483873762"
        },
        "paymentMethod":{
            "type":"string",
            "enum":[
                "CHK "
            ],
            "description":"Payment method\n* `CHK ` - System Check",
            "example":"CHK"
        },
        "paymentSelectionStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "D   ",
                "H   ",
                "N   ",
                "P   ",
                "R   ",
                "V   ",
                "X   "
            ],
            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
            "example":"P"
        },
        "adjustmentCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
        }
    }
}

Nested Schema : messageParameters

Type: object

Show Source

• parameters: array parameters

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterType":{
                        "type":"string",
                        "enum":[
                            "AMT ",
                            "DATE",
                            "DTTM",
                            "DUR ",
                            "FLD ",
                            "MMDD",
                            "MSG ",
                            "NBR ",
                            "SRVC",
                            "TBL ",
                            "TIME"
                        ],
                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                        "example":"FLD"
                    },
                    "parameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterType":{
                "type":"string",
                "enum":[
                    "AMT ",
                    "DATE",
                    "DTTM",
                    "DUR ",
                    "FLD ",
                    "MMDD",
                    "MSG ",
                    "NBR ",
                    "SRVC",
                    "TBL ",
                    "TIME"
                ],
                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                "example":"FLD"
            },
            "parameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• parameterType: string
  Allowed Values: [ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]

  Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameter

  Example: FLD
• parameterValue: string
  Maximum Length: 2000

  Message Parameter Value

{
    "type":"object",
    "properties":{
        "parameterType":{
            "type":"string",
            "enum":[
                "AMT ",
                "DATE",
                "DTTM",
                "DUR ",
                "FLD ",
                "MMDD",
                "MSG ",
                "NBR ",
                "SRVC",
                "TBL ",
                "TIME"
            ],
            "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
            "example":"FLD"
        },
        "parameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : UPDATE_response

Type: object

Show Source

• C1APChkRest: object C1APChkRest

{
    "type":"object",
    "properties":{
        "C1APChkRest":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "apRequestId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                            "example":"873490693226"
                        },
                        "paymentCurrency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Payment Currency",
                            "example":"USD"
                        },
                        "paidAmount":{
                            "type":"number",
                            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                            "example":"20.00"
                        },
                        "paymentDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                            "example":"2022-07-18"
                        },
                        "paymentNumber":{
                            "type":"string",
                            "maxLength":36,
                            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                            "example":"873483873762"
                        },
                        "paymentMethod":{
                            "type":"string",
                            "enum":[
                                "CHK "
                            ],
                            "description":"Payment method\n* `CHK ` - System Check",
                            "example":"CHK"
                        },
                        "paymentSelectionStatus":{
                            "type":"string",
                            "enum":[
                                "C   ",
                                "D   ",
                                "H   ",
                                "N   ",
                                "P   ",
                                "R   ",
                                "V   ",
                                "X   "
                            ],
                            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                            "example":"P"
                        },
                        "adjustmentCancelReason":{
                            "type":"string",
                            "maxLength":4,
                            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                        }
                    }
                },
                "errorInformation":{
                    "type":"object",
                    "properties":{
                        "hadError":{
                            "type":"boolean",
                            "description":"An error was encountered"
                        },
                        "errorText":{
                            "type":"string",
                            "maxLength":400,
                            "description":"Error Message"
                        },
                        "messageCategory":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Category"
                        },
                        "messageNumber":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number"
                        },
                        "messageParameters":{
                            "type":"object",
                            "properties":{
                                "parameters":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "parameterType":{
                                                "type":"string",
                                                "enum":[
                                                    "AMT ",
                                                    "DATE",
                                                    "DTTM",
                                                    "DUR ",
                                                    "FLD ",
                                                    "MMDD",
                                                    "MSG ",
                                                    "NBR ",
                                                    "SRVC",
                                                    "TBL ",
                                                    "TIME"
                                                ],
                                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                                "example":"FLD"
                                            },
                                            "parameterValue":{
                                                "type":"string",
                                                "maxLength":2000,
                                                "description":"Message Parameter Value"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : C1APChkRest

Type: object

Show Source

• errorInformation: object errorInformation
• input: object input

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "apRequestId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
                    "example":"873490693226"
                },
                "paymentCurrency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Payment Currency",
                    "example":"USD"
                },
                "paidAmount":{
                    "type":"number",
                    "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
                    "example":"20.00"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
                    "example":"2022-07-18"
                },
                "paymentNumber":{
                    "type":"string",
                    "maxLength":36,
                    "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
                    "example":"873483873762"
                },
                "paymentMethod":{
                    "type":"string",
                    "enum":[
                        "CHK "
                    ],
                    "description":"Payment method\n* `CHK ` - System Check",
                    "example":"CHK"
                },
                "paymentSelectionStatus":{
                    "type":"string",
                    "enum":[
                        "C   ",
                        "D   ",
                        "H   ",
                        "N   ",
                        "P   ",
                        "R   ",
                        "V   ",
                        "X   "
                    ],
                    "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
                    "example":"P"
                },
                "adjustmentCancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
                }
            }
        },
        "errorInformation":{
            "type":"object",
            "properties":{
                "hadError":{
                    "type":"boolean",
                    "description":"An error was encountered"
                },
                "errorText":{
                    "type":"string",
                    "maxLength":400,
                    "description":"Error Message"
                },
                "messageCategory":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Category"
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number"
                },
                "messageParameters":{
                    "type":"object",
                    "properties":{
                        "parameters":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "parameterType":{
                                        "type":"string",
                                        "enum":[
                                            "AMT ",
                                            "DATE",
                                            "DTTM",
                                            "DUR ",
                                            "FLD ",
                                            "MMDD",
                                            "MSG ",
                                            "NBR ",
                                            "SRVC",
                                            "TBL ",
                                            "TIME"
                                        ],
                                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                        "example":"FLD"
                                    },
                                    "parameterValue":{
                                        "type":"string",
                                        "maxLength":2000,
                                        "description":"Message Parameter Value"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : errorInformation

Type: object

Show Source

• errorText: string
  Maximum Length: 400

  Error Message
• hadError: boolean
  An error was encountered
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: object messageParameters

{
    "type":"object",
    "properties":{
        "hadError":{
            "type":"boolean",
            "description":"An error was encountered"
        },
        "errorText":{
            "type":"string",
            "maxLength":400,
            "description":"Error Message"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number"
        },
        "messageParameters":{
            "type":"object",
            "properties":{
                "parameters":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "parameterType":{
                                "type":"string",
                                "enum":[
                                    "AMT ",
                                    "DATE",
                                    "DTTM",
                                    "DUR ",
                                    "FLD ",
                                    "MMDD",
                                    "MSG ",
                                    "NBR ",
                                    "SRVC",
                                    "TBL ",
                                    "TIME"
                                ],
                                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                                "example":"FLD"
                            },
                            "parameterValue":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• adjustmentCancelReason: string
  Maximum Length: 4

  Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled.
• apRequestId: string
  Maximum Length: 12

  AP Request ID is the system-assigned, unique identifier of the AP check request.

  Example: 873490693226
• paidAmount: number
  Paid Amount is the amount of the check. This field can be provided after AP cuts the check.

  Example: 20.00
• paymentCurrency: string
  Maximum Length: 3

  Payment Currency

  Example: USD
• paymentDate: string (date)
  Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.

  Example: 2022-07-18
• paymentMethod: string
  Allowed Values: [ "CHK " ]

  Payment method * `CHK ` - System Check

  Example: CHK
• paymentNumber: string
  Maximum Length: 36

  Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.

  Example: 873483873762
• paymentSelectionStatus: string
  Allowed Values: [ "C ", "D ", "H ", "N ", "P ", "R ", "V ", "X " ]

  Payment Selection Status is the status of the check request. The values are: ??? Not Selected for Payment before it's selected by AP for payment ??? Requested for Payment after it's selected by AP ??? Paid after it's paid by AP ??? Canceled if it's been canceled in AP ??? Hold if it's been held in AP * `C ` - Closed, * `D ` - Negative Voucher Sum, * `H ` - Held, * `N ` - Not Selected for Payment, * `P ` - Paid, * `R ` - Requested for Payment, * `V ` - Convert Error, * `X ` - Canceled

  Example: P

{
    "type":"object",
    "properties":{
        "apRequestId":{
            "type":"string",
            "maxLength":12,
            "description":"AP Request ID is the system-assigned, unique identifier of the AP check request.",
            "example":"873490693226"
        },
        "paymentCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Payment Currency",
            "example":"USD"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount is the amount of the check. This field can be provided after AP cuts the check.",
            "example":"20.00"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Date is the date on which the check was cut in AP. This field is provided after AP cuts the check.",
            "example":"2022-07-18"
        },
        "paymentNumber":{
            "type":"string",
            "maxLength":36,
            "description":"Payment Number is the system-assigned number of the payment in AP (this number typically appears on the printed check). This field can be provided after AP cuts the check.",
            "example":"873483873762"
        },
        "paymentMethod":{
            "type":"string",
            "enum":[
                "CHK "
            ],
            "description":"Payment method\n* `CHK ` - System Check",
            "example":"CHK"
        },
        "paymentSelectionStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "D   ",
                "H   ",
                "N   ",
                "P   ",
                "R   ",
                "V   ",
                "X   "
            ],
            "description":"Payment Selection Status is the status of the check request. The values are:\n??? Not Selected for Payment before it's selected by AP for payment\n??? Requested for Payment after it's selected by AP\n??? Paid after it's paid by AP\n??? Canceled if it's been canceled in AP\n??? Hold if it's been held in AP\n* `C   ` - Closed,\n* `D   ` - Negative Voucher Sum,\n* `H   ` - Held,\n* `N   ` - Not Selected for Payment,\n* `P   ` - Paid,\n* `R   ` - Requested for Payment,\n* `V   ` - Convert Error,\n* `X   ` - Canceled",
            "example":"P"
        },
        "adjustmentCancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Adjustment Cancel Reason describes the reason for cancelling related adjustment when AP Check Request gets canceled."
        }
    }
}

Nested Schema : messageParameters

Type: object

Show Source

• parameters: array parameters

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterType":{
                        "type":"string",
                        "enum":[
                            "AMT ",
                            "DATE",
                            "DTTM",
                            "DUR ",
                            "FLD ",
                            "MMDD",
                            "MSG ",
                            "NBR ",
                            "SRVC",
                            "TBL ",
                            "TIME"
                        ],
                        "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                        "example":"FLD"
                    },
                    "parameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterType":{
                "type":"string",
                "enum":[
                    "AMT ",
                    "DATE",
                    "DTTM",
                    "DUR ",
                    "FLD ",
                    "MMDD",
                    "MSG ",
                    "NBR ",
                    "SRVC",
                    "TBL ",
                    "TIME"
                ],
                "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
                "example":"FLD"
            },
            "parameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• parameterType: string
  Allowed Values: [ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]

  Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameter

  Example: FLD
• parameterValue: string
  Maximum Length: 2000

  Message Parameter Value

{
    "type":"object",
    "properties":{
        "parameterType":{
            "type":"string",
            "enum":[
                "AMT ",
                "DATE",
                "DTTM",
                "DUR ",
                "FLD ",
                "MMDD",
                "MSG ",
                "NBR ",
                "SRVC",
                "TBL ",
                "TIME"
            ],
            "description":"Message Parameter Type\n* `AMT ` - Amount parameter,\n* `DATE` - Date format parameter,\n* `DTTM` - Date/time format parameter,\n* `DUR ` - Duration parameter,\n* `FLD ` - Field name parameter,\n* `MMDD` - Month/Day format parameter,\n* `MSG ` - Message parameter,\n* `NBR ` - Numeric parameter,\n* `SRVC` - Service name parameter,\n* `TBL ` - Table name parameter,\n* `TIME` - Time format parameter",
            "example":"FLD"
        },
        "parameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter Value"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top