Jump to

• Request
• Response

Get all award distributions

get

/fscmRestApi/resources/11.13.18.05/projectAwardDistributions

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds an award distribution based on the unique identifier.
    Finder Variables
    • AwardDistributionId; integer; Finds an award distribution based on the unique identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AwardDistributionBatchId; integer; Batch identifier assigned to the set of transactions provided in the input payload.
  • AwardDistributionId; integer; Unique identifier of the transactions in the batch.
  • AwardDistributionStatus; string; Award distribution status indicator for the transaction.
  • CreatedBy; string; The user that created the record.
  • CreationDate; string; The date when the record was created.
  • DenomCurrencyCode; string; The transaction currency code.
  • DistributePatternId; integer; Unique identifier of the funding pattern that was used to distribute the transaction.
  • DistributePatternSetId; integer; Unique identifier of the funding pattern distribution set that was used to distribute the transaction.
  • FundingPatternEnd; string; The end date of the funding pattern that, with the start date, defines the expenditure item date range applicable to the pattern.
  • FundingPatternName; string; The user-defined name of the funding pattern.
  • FundingPatternStart; string; The start date of the funding pattern that, with the end date, defines the expenditure item date range applicable to the pattern.
  • FundingPatternStatus; string; The status of the funding pattern at the time this distribution was created.
  • FundingPatternTaskName; string; The name of the project task defined as a determinant on the funding pattern.
  • FundingPatternTaskNumber; string; The number of the project task defined as a determinant on the funding pattern.
  • LastUpdateDate; string; The date the record was last updated.
  • LastUpdatedBy; string; The user that last updated the record.
  • ProjectName; string; The name of the project associated with the cost to be distributed.
  • ProjectNumber; string; The number of the project on the cost to be distributed.
  • ProviderLedgerCurrencyCode; string; The provider ledger currency code.
  • SourceLineIdFive; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • SourceLineIdFour; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • SourceLineIdOne; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • SourceLineIdSix; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • SourceLineIdThree; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • SourceLineIdTwo; string; Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
  • TransactionNumber; string; The transaction number that uniquely identifies the source transaction within the application.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

There's no request body for this operation.

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 : projectAwardDistributions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectAwardDistributions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectAwardDistributions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectAwardDistributions-item-response"
    }
}

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 : projectAwardDistributions-item-response

Type: object

Show Source

• AwardDistributionBatchId: integer (int64)
  Batch identifier assigned to the set of transactions provided in the input payload.
• AwardDistributionId: integer (int64)
  Read Only: true

  Unique identifier of the transactions in the batch.
• AwardDistributionStatus: string
  Maximum Length: 30

  Award distribution status indicator for the transaction.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DenomCurrencyCode: string
  Maximum Length: 15

  The transaction currency code.
• DistributePatternId: integer (int64)
  Unique identifier of the funding pattern that was used to distribute the transaction.
• DistributePatternSetId: integer (int64)
  Unique identifier of the funding pattern distribution set that was used to distribute the transaction.
• FundingPatternEnd: string (date)
  Read Only: true

  The end date of the funding pattern that, with the start date, defines the expenditure item date range applicable to the pattern.
• FundingPatternName: string
  Read Only: true

  Maximum Length: 200

  The user-defined name of the funding pattern.
• FundingPatternStart: string (date)
  Read Only: true

  The start date of the funding pattern that, with the end date, defines the expenditure item date range applicable to the pattern.
• FundingPatternStatus: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The status of the funding pattern at the time this distribution was created.
• FundingPatternTaskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  The name of the project task defined as a determinant on the funding pattern.
• FundingPatternTaskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  The number of the project task defined as a determinant on the funding pattern.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectAwardDistributionErrors: array Project Award Distribution Errors
  Title: Project Award Distribution Errors

  This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.
• ProjectAwardDistributionLines: array Project Award Cost Distribution Records
  Title: Project Award Cost Distribution Records

  This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.
• ProjectAwardDistributionSuccessLines: array Project Award Cost Distribution Records
  Title: Project Award Cost Distribution Records

  This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project associated with the cost to be distributed.
• ProjectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The number of the project on the cost to be distributed.
• ProviderLedgerCurrencyCode: string
  Maximum Length: 15

  The provider ledger currency code.
• SourceLineIdFive: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• SourceLineIdFour: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• SourceLineIdOne: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• SourceLineIdSix: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• SourceLineIdThree: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• SourceLineIdTwo: string
  Maximum Length: 30

  Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.
• TransactionNumber: string
  Maximum Length: 240

  The transaction number that uniquely identifies the source transaction within the application.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"The transaction number that uniquely identifies the source transaction within the application.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the project associated with the cost to be distributed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingPatternEnd":{
            "type":"string",
            "description":"The end date of the funding pattern that, with the start date, defines the expenditure item date range applicable to the pattern.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingPatternTaskName":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project task defined as a determinant on the funding pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineIdThree":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionBatchId":{
            "type":"integer",
            "description":"Batch identifier assigned to the set of transactions provided in the input payload.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingPatternName":{
            "maxLength":"200",
            "type":"string",
            "description":"The user-defined name of the funding pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardDistributionId":{
            "type":"integer",
            "description":"Unique identifier of the transactions in the batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingPatternTaskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The number of the project task defined as a determinant on the funding pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributePatternId":{
            "type":"integer",
            "description":"Unique identifier of the funding pattern that was used to distribute the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingPatternStatus":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the funding pattern at the time this distribution was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectAwardDistributionSuccessLines":{
            "title":"Project Award Cost Distribution Records",
            "type":"array",
            "description":"This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.",
            "items":{
                "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionSuccessLines-item-response"
            }
        },
        "DenomCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The transaction currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineIdOne":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingPatternStart":{
            "type":"string",
            "description":"The start date of the funding pattern that, with the end date, defines the expenditure item date range applicable to the pattern.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineIdSix":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"The number of the project on the cost to be distributed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLineIdFive":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Award distribution status indicator for the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "DistributePatternSetId":{
            "type":"integer",
            "description":"Unique identifier of the funding pattern distribution set that was used to distribute the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceLineIdFour":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectAwardDistributionErrors":{
            "title":"Project Award Distribution Errors",
            "type":"array",
            "description":"This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.",
            "items":{
                "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionErrors-item-response"
            }
        },
        "ProjectAwardDistributionLines":{
            "title":"Project Award Cost Distribution Records",
            "type":"array",
            "description":"This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.",
            "items":{
                "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionLines-item-response"
            }
        },
        "SourceLineIdTwo":{
            "maxLength":"30",
            "type":"string",
            "description":"Primary key identifier populated and used with the batch identifier by the source application that's invoking the award distribution process.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderLedgerCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The provider ledger currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Project Award Distribution Errors

Type: array

Title: Project Award Distribution Errors

This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.

Show Source

• Array of: object projectAwardDistributions-ProjectAwardDistributionErrors-item-response

{
    "title":"Project Award Distribution Errors",
    "type":"array",
    "description":"This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.",
    "items":{
        "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionErrors-item-response"
    }
}

Nested Schema : Project Award Cost Distribution Records

Type: array

Title: Project Award Cost Distribution Records

This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.

Show Source

• Array of: object projectAwardDistributions-ProjectAwardDistributionLines-item-response

{
    "title":"Project Award Cost Distribution Records",
    "type":"array",
    "description":"This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.",
    "items":{
        "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionLines-item-response"
    }
}

Nested Schema : Project Award Cost Distribution Records

Type: array

Title: Project Award Cost Distribution Records

This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.

Show Source

• Array of: object projectAwardDistributions-ProjectAwardDistributionSuccessLines-item-response

{
    "title":"Project Award Cost Distribution Records",
    "type":"array",
    "description":"This is a child resource of Project Award Distributions that provides the cost distribution records created by the Award Distribution process.",
    "items":{
        "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionSuccessLines-item-response"
    }
}

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."
        }
    }
}

Nested Schema : projectAwardDistributions-ProjectAwardDistributionErrors-item-response

Type: object

Show Source

• ApplicationCode: string
  Read Only: true

  Maximum Length: 10

  The application code associated with the message.
• ErrorAction: string
  Read Only: true

  Maximum Length: 255

  The description of the action that users should take to resolve the error.
• ErrorGroup: string
  Read Only: true

  Maximum Length: 30

  Name of the award distribution processing stage that generated the error.
• InterfaceId: integer (int64)
  Read Only: true

  Identifier of the request that initiated the process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Read Only: true

  Maximum Length: 30

  The name of the error message associated with the transaction.
• MessageText: string
  Read Only: true

  Maximum Length: 255

  Award distribution error message text.
• MessageTypeCode: string
  Read Only: true

  Maximum Length: 20

  The type of error message associated with the transaction.
• SourceTransactionId: integer (int64)
  Read Only: true

  The identifier of the source of the transaction.
• TransactionErrorId: integer (int64)
  Read Only: true

  Unique identifier of the distribution error record.

{
    "type":"object",
    "properties":{
        "MessageTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The type of error message associated with the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorAction":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the action that users should take to resolve the error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorGroup":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the award distribution processing stage that generated the error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "type":"integer",
            "description":"The identifier of the source of the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageText":{
            "maxLength":"255",
            "type":"string",
            "description":"Award distribution error message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InterfaceId":{
            "type":"integer",
            "description":"Identifier of the request that initiated the process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionErrorId":{
            "type":"integer",
            "description":"Unique identifier of the distribution error record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The application code associated with the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the error message associated with the transaction.",
            "nullable":false,
            "readOnly":true,
            "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 : projectAwardDistributions-ProjectAwardDistributionLines-item-response

Type: object

Show Source

• AwardDistributionId: integer (int64)
  Unique identifier of the award distribution associated with the distribution line.
• AwardDistributionLineId: integer (int64)
  Read Only: true

  Unique identifier of the distribution line.
• AwardDistributionStatus: string
  Maximum Length: 30

  Award distribution status indicator associated with the distribution line.
• AwardName: string
  Title: Name

  Read Only: true

  Maximum Length: 300

  The name of the award on the funding pattern distribution set rule.
• AwardNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 120

  The number of the award on the funding pattern distribution set rule.
• BudgetaryControlValueStatus: string
  Maximum Length: 120

  Budgetary control status of the distribution line, indicating whether it passed the check funds process.
• BurdenedCostInProviderLedgerCurrency: number
  Distributed burdened cost in provider ledger currency.
• ContractId: integer (int64)
  Identifier of the contract from the distribution rule that created the distribution line.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DenomBurdenedCost: number
  Distributed burdened cost in transaction currency.
• DenomRawCost: number
  Distributed raw cost upon applying the distribution percentage, in transaction currency.
• DistBaseAmount: number
  Raw cost from the original transaction, in transaction currency.
• DistBaseQuantity: number
  Quantity from the original transaction.
• DistBurdenedCostInProviderLedgerCurrency: number
  Burdened cost from the original transaction, in provider ledger currency.
• DistDenomBurdenedCost: number
  Burdened cost from original transaction, in transaction currency.
• DistRawCostInProviderLedgerCurrency: number
  Raw cost from original transaction, in provider ledger currency.
• DistributePatternRuleId: integer (int64)
  Identifier of the funding pattern distribution set rule.
• DistributePatternSetId: integer (int64)
  Identifier of the distribution set that's the parent to the rule used to generate this line.
• DistributeRuleSetNumber: integer (int32)
  Number of the funding pattern distribution set.
• DistributionPercentage: number
  Percentage of the funding pattern distribution set rule.
• DistributionSetName: string
  Read Only: true

  Maximum Length: 200

  The user-defined name of the distribution set.
• DistributionSetPrecedence: integer (int32)
  Order in which the distribution rules in the funding pattern distribution set must be applied.
• FundingSourceId: integer (int64)
  Identifier of the contract funding source in the distribution rule that created the distribution line.
• FundingSourceName: string
  Read Only: true

  Maximum Length: 360

  The name of the funding source on the funding pattern distribution set rule.
• FundingSourceNumber: string
  Read Only: true

  Maximum Length: 50

  The number of the funding source on the funding pattern distribution set rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectAwardDistributionErrors: array Project Award Distribution Errors
  Title: Project Award Distribution Errors

  This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.
• Quantity: number
  Quantity distributed upon applying the distribution percentage.
• RawCostInProviderLedgerCurrency: number
  Distributed raw cost in provider ledger currency.
• ValidationStatusCode: string
  Maximum Length: 30

  The distribution line validation code, indicating whether it passed project cost validation.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistRawCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Raw cost from original transaction, in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionSetPrecedence":{
            "type":"integer",
            "description":"Order in which the distribution rules in the funding pattern distribution set must be applied.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DenomBurdenedCost":{
            "type":"number",
            "description":"Distributed burdened cost in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionPercentage":{
            "type":"number",
            "description":"Percentage of the funding pattern distribution set rule.",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "BurdenedCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Distributed burdened cost in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistBaseQuantity":{
            "type":"number",
            "description":"Quantity from the original transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "DistDenomBurdenedCost":{
            "type":"number",
            "description":"Burdened cost from original transaction, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionId":{
            "type":"integer",
            "description":"Unique identifier of the award distribution associated with the distribution line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistBurdenedCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Burdened cost from the original transaction, in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AwardName":{
            "title":"Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the award on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Distributed raw cost in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardDistributionLineId":{
            "type":"integer",
            "description":"Unique identifier of the distribution line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistBaseAmount":{
            "type":"number",
            "description":"Raw cost from the original transaction, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The distribution line validation code, indicating whether it passed project cost validation.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity distributed upon applying the distribution percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Award distribution status indicator associated with the distribution line.",
            "nullable":false,
            "x-queryable":true
        },
        "DistributePatternSetId":{
            "type":"integer",
            "description":"Identifier of the distribution set that's the parent to the rule used to generate this line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Identifier of the contract from the distribution rule that created the distribution line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the funding source on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectAwardDistributionErrors":{
            "title":"Project Award Distribution Errors",
            "type":"array",
            "description":"This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.",
            "items":{
                "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionLines-ProjectAwardDistributionErrors-item-response"
            }
        },
        "FundingSourceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The number of the funding source on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributionSetName":{
            "maxLength":"200",
            "type":"string",
            "description":"The user-defined name of the distribution set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingSourceId":{
            "type":"integer",
            "description":"Identifier of the contract funding source in the distribution rule that created the distribution line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AwardNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The number of the award on the funding pattern distribution set rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributePatternRuleId":{
            "type":"integer",
            "description":"Identifier of the funding pattern distribution set rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistributeRuleSetNumber":{
            "type":"integer",
            "description":"Number of the funding pattern distribution set.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BudgetaryControlValueStatus":{
            "maxLength":"120",
            "type":"string",
            "description":"Budgetary control status of the distribution line, indicating whether it passed the check funds process.",
            "nullable":true,
            "x-queryable":true
        },
        "DenomRawCost":{
            "type":"number",
            "description":"Distributed raw cost upon applying the distribution percentage, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Project Award Distribution Errors

Type: array

Title: Project Award Distribution Errors

This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.

Show Source

• Array of: object projectAwardDistributions-ProjectAwardDistributionLines-ProjectAwardDistributionErrors-item-response

{
    "title":"Project Award Distribution Errors",
    "type":"array",
    "description":"This is a child resource of Project Award Distributions and provides the errors identified when validating the cost during the award distribution process.",
    "items":{
        "$ref":"#/components/schemas/projectAwardDistributions-ProjectAwardDistributionLines-ProjectAwardDistributionErrors-item-response"
    }
}

Nested Schema : projectAwardDistributions-ProjectAwardDistributionLines-ProjectAwardDistributionErrors-item-response

Type: object

Show Source

• ApplicationCode: string
  Read Only: true

  Maximum Length: 10

  The application code associated with the message.
• ErrorAction: string
  Read Only: true

  Maximum Length: 255

  The description of the action that users should take to resolve the error.
• ErrorGroup: string
  Read Only: true

  Maximum Length: 30

  Name of the award distribution processing stage that generated the error.
• InterfaceId: integer (int64)
  Read Only: true

  Identifier of the request that initiated the process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageName: string
  Read Only: true

  Maximum Length: 30

  The name of the error message associated with the transaction.
• MessageText: string
  Read Only: true

  Maximum Length: 255

  Award distribution error message text.
• MessageTypeCode: string
  Read Only: true

  Maximum Length: 20

  The type of error message associated with the transaction.
• SourceTransactionId: integer (int64)
  Read Only: true

  The identifier of the source of the transaction.
• TransactionErrorId: integer (int64)
  Read Only: true

  Unique identifier of the distribution error record.

{
    "type":"object",
    "properties":{
        "MessageTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The type of error message associated with the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorAction":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the action that users should take to resolve the error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorGroup":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the award distribution processing stage that generated the error.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "type":"integer",
            "description":"The identifier of the source of the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageText":{
            "maxLength":"255",
            "type":"string",
            "description":"Award distribution error message text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InterfaceId":{
            "type":"integer",
            "description":"Identifier of the request that initiated the process.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionErrorId":{
            "type":"integer",
            "description":"Unique identifier of the distribution error record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The application code associated with the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":"30",
            "type":"string",
            "description":"The name of the error message associated with the transaction.",
            "nullable":false,
            "readOnly":true,
            "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 : projectAwardDistributions-ProjectAwardDistributionSuccessLines-item-response

Type: object

Show Source

• AwardDistributionId: integer (int64)
  Unique identifier of the award distribution associated with the distribution line.
• AwardDistributionLineId: integer (int64)
  Read Only: true

  Unique identifier of the distribution line.
• AwardDistributionStatus: string
  Maximum Length: 30

  Award distribution status indicator associated with the distribution line.
• AwardName: string
  Title: Name

  Read Only: true

  Maximum Length: 300

  The name of the award on the funding pattern distribution set rule.
• AwardNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 120

  The number of the award on the funding pattern distribution set rule.
• BudgetaryControlValueStatus: string
  Maximum Length: 120

  Budgetary control status of the distribution line, indicating whether it passed the check funds process.
• BurdenedCostInProviderLedgerCurrency: number
  Distributed burdened cost in provider ledger currency.
• ContractId: integer (int64)
  Identifier of the contract from the distribution rule that created the distribution line.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DenomBurdenedCost: number
  Distributed burdened cost in transaction currency.
• DenomRawCost: number
  Distributed raw cost upon applying the distribution percentage, in transaction currency.
• DistBaseAmount: number
  Raw cost from the original transaction, in transaction currency.
• DistBaseQuantity: number
  Quantity from the original transaction.
• DistBurdenedCostInProviderLedgerCurrency: number
  Burdened cost from the original transaction, in provider ledger currency.
• DistDenomBurdenedCost: number
  Burdened cost from original transaction, in transaction currency.
• DistRawCostInProviderLedgerCurrency: number
  Raw cost from original transaction, in provider ledger currency.
• DistributePatternRuleId: integer (int64)
  Identifier of the funding pattern distribution set rule.
• DistributePatternSetId: integer (int64)
  Identifier of the distribution set that's the parent to the rule used to generate this line.
• DistributeRuleSetNumber: integer (int32)
  Number of the funding pattern distribution set.
• DistributionPercentage: number
  Percentage of the funding pattern distribution set rule.
• DistributionSetName: string
  Read Only: true

  Maximum Length: 200

  The user-defined name of the distribution set.
• DistributionSetPrecedence: integer (int32)
  Order in which the distribution rules in the funding pattern distribution set must be applied.
• FundingSourceId: integer (int64)
  Identifier of the contract funding source in the distribution rule that created the distribution line.
• FundingSourceName: string
  Read Only: true

  Maximum Length: 360

  The name of the funding source on the funding pattern distribution set rule.
• FundingSourceNumber: string
  Read Only: true

  Maximum Length: 50

  The number of the funding source on the funding pattern distribution set rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Quantity distributed upon applying the distribution percentage.
• RawCostInProviderLedgerCurrency: number
  Distributed raw cost in provider ledger currency.
• ValidationStatusCode: string
  Maximum Length: 30

  The distribution line validation code, indicating whether it passed project cost validation.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistRawCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Raw cost from original transaction, in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionSetPrecedence":{
            "type":"integer",
            "description":"Order in which the distribution rules in the funding pattern distribution set must be applied.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DenomBurdenedCost":{
            "type":"number",
            "description":"Distributed burdened cost in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionPercentage":{
            "type":"number",
            "description":"Percentage of the funding pattern distribution set rule.",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "BurdenedCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Distributed burdened cost in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DistBaseQuantity":{
            "type":"number",
            "description":"Quantity from the original transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "DistDenomBurdenedCost":{
            "type":"number",
            "description":"Burdened cost from original transaction, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionId":{
            "type":"integer",
            "description":"Unique identifier of the award distribution associated with the distribution line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistBurdenedCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Burdened cost from the original transaction, in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AwardName":{
            "title":"Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the award on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawCostInProviderLedgerCurrency":{
            "type":"number",
            "description":"Distributed raw cost in provider ledger currency.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardDistributionLineId":{
            "type":"integer",
            "description":"Unique identifier of the distribution line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistBaseAmount":{
            "type":"number",
            "description":"Raw cost from the original transaction, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The distribution line validation code, indicating whether it passed project cost validation.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity distributed upon applying the distribution percentage.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDistributionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Award distribution status indicator associated with the distribution line.",
            "nullable":false,
            "x-queryable":true
        },
        "DistributePatternSetId":{
            "type":"integer",
            "description":"Identifier of the distribution set that's the parent to the rule used to generate this line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Identifier of the contract from the distribution rule that created the distribution line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the funding source on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingSourceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The number of the funding source on the funding pattern distribution set rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributionSetName":{
            "maxLength":"200",
            "type":"string",
            "description":"The user-defined name of the distribution set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingSourceId":{
            "type":"integer",
            "description":"Identifier of the contract funding source in the distribution rule that created the distribution line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AwardNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The number of the award on the funding pattern distribution set rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributePatternRuleId":{
            "type":"integer",
            "description":"Identifier of the funding pattern distribution set rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistributeRuleSetNumber":{
            "type":"integer",
            "description":"Number of the funding pattern distribution set.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BudgetaryControlValueStatus":{
            "maxLength":"120",
            "type":"string",
            "description":"Budgetary control status of the distribution line, indicating whether it passed the check funds process.",
            "nullable":true,
            "x-queryable":true
        },
        "DenomRawCost":{
            "type":"number",
            "description":"Distributed raw cost upon applying the distribution percentage, in transaction currency.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Links

projectAwardDistribution

Operation: /fscmRestApi/resources/11.13.18.05/projectAwardDistributions/action/projectAwardDistribution

Call Award Distribution for one or more transactions and get the results of the operation.

Back to Top