Jump to

• Request
• Response

Update a receipt option for a payment method

patch

/fscmRestApi/resources/11.13.18.05/publicSectorERPReceiptOptions/{publicSectorERPReceiptOptionsUniqID}

Request

Path Parameters

• publicSectorERPReceiptOptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, InvoiceSystem and PaymentMethodCode ---for the ERP Receipt Options resource and used to uniquely identify an instance of ERP Receipt Options. The client should not generate the hash key value. Instead, the client should query on the ERP Receipt Options collection resource with a filter on the primary key values in order to navigate to a specific instance of ERP Receipt Options.
  
  For example: publicSectorERPReceiptOptions?q=AgencyId=<value1>;InvoiceSystem=<value2>;PaymentMethodCode=<value3>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ReceiptMethodName: string
  Title: Receipt Method Name

  Maximum Length: 30

  Name of receipt method that should be associated with the receipt.
• RemittanceAccountName: string
  Title: Remittance Account Name

  Maximum Length: 360

  Name of remittance account that should be associated with the receipt.

{
    "type":"object",
    "properties":{
        "RemittanceAccountName":{
            "title":"Remittance Account Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of remittance account that should be associated with the receipt.",
            "nullable":false
        },
        "ReceiptMethodName":{
            "title":"Receipt Method Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of receipt method that should be associated with the receipt.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorERPReceiptOptions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  Unique identifier of the agency associated with the receipt options.
• InvoiceSystem: string
  Maximum Length: 20

  Code of receivable application where receipt should be created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentMethodCode: string
  Maximum Length: 30

  Code of payment method code associated with the payment.
• ReceiptMethodName: string
  Title: Receipt Method Name

  Maximum Length: 30

  Name of receipt method that should be associated with the receipt.
• RemittanceAccountName: string
  Title: Remittance Account Name

  Maximum Length: 360

  Name of remittance account that should be associated with the receipt.

{
    "type":"object",
    "properties":{
        "RemittanceAccountName":{
            "title":"Remittance Account Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of remittance account that should be associated with the receipt.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReceiptMethodName":{
            "title":"Receipt Method Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of receipt method that should be associated with the receipt.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Unique identifier of the agency associated with the receipt options.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "InvoiceSystem":{
            "maxLength":20,
            "type":"string",
            "description":"Code of receivable application where receipt should be created.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of payment method code associated with the payment.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top