Jump to

• Request
• Response

Get all customer invoice data

get

/fscmRestApi/resources/11.13.18.05/publicSectorCustomerInvoices

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: Primary key for customer invoice
    Finder Variables:
    • TrxnCustInvKey; integer; Transaction customer invoice primary key
• 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:
  

  • AdjustmentAmount; number; The adjusted invoice amount.
  • AgencyId; integer; Identifier of the agency associated with the invoice.
  • BalanceAmount; number; Balance due on the invoice.
  • Classification; string; Classification of the record type.
  • ClassificationDesc; string; Descriptive value of classification for a record type.
  • CompleteFlag; string; Indicates whether the invoice is complete.
  • CompleteFlagDesc; string; Descriptive value of the complete mark.
  • CreditAmount; number; Amount credited against the invoice.
  • CurrencyCode; string; Currency of the invoice.
  • CustAccountId; integer; Identifier of the customer account.
  • CustAccountName; string; Name of the customer account.
  • CustAccountNumber; string; Number of the customer account.
  • CustAcctSiteId; integer; Identifier of the site for a customer account.
  • CustPartyId; integer; Identifier of the party for a customer account.
  • CustPartyNumber; string; Number of the party for a customer account.
  • CustPartyTypeCd; string; Code of the party type for a customer account.
  • CustSiteUseId; integer; Identifier of the customer account site usage.
  • DisputeAmount; number; The invoice amount disputed.
  • Invoice; string; Unique number assigned to the invoice.
  • InvoiceAmount; number; Amount of the invoice.
  • InvoiceDate; string; Date on the invoice.
  • InvoiceId; integer; Unique identifier assigned to the invoice.
  • InvoiceRequestId; integer; The process request identifier.
  • InvoiceStatus; string; Status of the invoice.
  • InvoiceSystemCd; string; Code identifying the receivables application.
  • InvoiceSystemDesc; string; Description of the receivable application.
  • LastSyncDate; string; Date on which the invoice data was last synced.
  • LocationId; integer; Identifier of the address location.
  • PaidAmount; number; Amount collected for the invoice.
  • PartySiteName; string; Name of the party site.
  • PartyTypeDesc; string; Descriptive value of the party type.
  • RecordId; string; Identifier of the application associated with the invoice.
  • RecordKey; integer; Numeric key of the application associated with the invoice.
  • RecordType; string; Identifies application type associated with the transaction.
  • RecordTypeId; string; Identifier of the record type of the invoice.
  • SetName; string; Reference set name for the billing address.
  • TrxnCustInvId; string; Alpha numeric identifier for the record.
  • TrxnCustInvKey; integer; Unique numeric key for the record.
  • TrxnCustXrefId; string; Alpha numeric identifier assigned to customer cross reference record.
  • TrxnCustXrefKey; integer; Numeric key assigned to a customer cross reference record.
• 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: 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.

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

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/publicSectorCustomerInvoices-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BillingandPayment",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCustomerInvoices-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCustomerInvoices-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 : publicSectorCustomerInvoices-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Adjustment Amount

  The adjusted invoice amount.
• AgencyId: integer (int32)
  Title: Agency ID

  Identifier of the agency associated with the invoice.
• BalanceAmount: number
  Title: Balance Amount

  Balance due on the invoice.
• Classification: string
  Title: Classification

  Maximum Length: 3

  Classification of the record type.
• ClassificationDesc: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  Descriptive value of classification for a record type.
• CompleteFlag: string
  Maximum Length: 1

  Indicates whether the invoice is complete.
• CompleteFlagDesc: string
  Title: Completed Mark

  Read Only: true

  Maximum Length: 80

  Descriptive value of the complete mark.
• CreditAmount: number
  Title: Credit Amount

  Amount credited against the invoice.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  Currency of the invoice.
• CustAccountId: integer (int64)
  Title: Customer Account ID

  Identifier of the customer account.
• CustAccountName: string
  Title: Account Name

  Maximum Length: 240

  Name of the customer account.
• CustAccountNumber: string
  Title: Customer Account Number

  Maximum Length: 30

  Number of the customer account.
• CustAcctSiteId: integer (int64)
  Title: Customer Account Site ID

  Identifier of the site for a customer account.
• CustPartyId: integer (int64)
  Title: Party ID

  Identifier of the party for a customer account.
• CustPartyNumber: string
  Title: Party Number

  Maximum Length: 30

  Number of the party for a customer account.
• CustPartyTypeCd: string
  Maximum Length: 30

  Code of the party type for a customer account.
• CustSiteUseId: integer (int64)
  Title: Site Use ID

  Identifier of the customer account site usage.
• DisputeAmount: number
  Title: Dispute Amount

  The invoice amount disputed.
• Invoice: string
  Maximum Length: 50

  Unique number assigned to the invoice.
• InvoiceAmount: number
  Title: Invoice Amount

  Amount of the invoice.
• InvoiceDate: string (date)
  Title: Invoice Date

  Date on the invoice.
• InvoiceId: integer (int64)
  Title: Invoice ID

  Unique identifier assigned to the invoice.
• InvoiceRequestId: integer (int64)
  Title: Request ID

  The process request identifier.
• InvoiceStatus: string
  Maximum Length: 30

  Status of the invoice.
• InvoiceSystemCd: string
  Maximum Length: 30

  Code identifying the receivables application.
• InvoiceSystemDesc: string
  Title: Invoice System Code

  Read Only: true

  Maximum Length: 80

  Description of the receivable application.
• LastSyncDate: string (date-time)
  Title: Last Sync Date Time

  Date on which the invoice data was last synced.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Title: Location ID

  Identifier of the address location.
• PaidAmount: number
  Title: Paid Amount

  Amount collected for the invoice.
• PartySiteName: string
  Title: Party Site Name

  Maximum Length: 240

  Name of the party site.
• PartyTypeDesc: string
  Title: Party Type Code

  Read Only: true

  Maximum Length: 80

  Descriptive value of the party type.
• RecordId: string
  Title: Record ID

  Maximum Length: 50

  Identifier of the application associated with the invoice.
• RecordKey: integer (int64)
  Title: Record Key

  Numeric key of the application associated with the invoice.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 100

  Identifies application type associated with the transaction.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 50

  Identifier of the record type of the invoice.
• SetName: string
  Title: Set Name

  Maximum Length: 80

  Reference set name for the billing address.
• TrxnCustInvId: string
  Title: Transaction Invoice ID

  Maximum Length: 50

  Alpha numeric identifier for the record.
• TrxnCustInvKey: integer (int64)
  Unique numeric key for the record.
• TrxnCustXrefId: string
  Title: Customer Cross Reference ID

  Maximum Length: 50

  Alpha numeric identifier assigned to customer cross reference record.
• TrxnCustXrefKey: integer (int64)
  Numeric key assigned to a customer cross reference record.

{
    "type":"object",
    "properties":{
        "Invoice":{
            "maxLength":50,
            "type":"string",
            "description":"Unique number assigned to the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifier of the agency associated with the invoice.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordKey":{
            "title":"Record Key",
            "type":"integer",
            "description":"Numeric key of the application associated with the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "title":"Credit Amount",
            "type":"number",
            "description":"Amount credited against the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CustAccountName":{
            "title":"Account Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "CustPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Identifier of the party for a customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"Amount of the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Unique identifier assigned to the invoice.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency of the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "DisputeAmount":{
            "title":"Dispute Amount",
            "type":"number",
            "description":"The invoice amount disputed.",
            "nullable":true,
            "x-queryable":true
        },
        "CustSiteUseId":{
            "title":"Site Use ID",
            "type":"integer",
            "description":"Identifier of the customer account site usage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":100,
            "type":"string",
            "description":"Identifies application type associated with the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"Classification of the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Party Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifier of the record type of the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"The adjusted invoice amount.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoiceDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Date on the invoice.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifier of the application associated with the invoice.",
            "nullable":false,
            "x-queryable":true
        },
        "CompleteFlagDesc":{
            "title":"Completed Mark",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive value of the complete mark.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrxnCustXrefKey":{
            "type":"integer",
            "description":"Numeric key assigned to a customer cross reference record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustPartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Number of the party for a customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustInvId":{
            "title":"Transaction Invoice ID",
            "maxLength":50,
            "type":"string",
            "description":"Alpha numeric identifier for the record.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceAmount":{
            "title":"Balance Amount",
            "type":"number",
            "description":"Balance due on the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Identifier of the address location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustAccountNumber":{
            "title":"Customer Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Number of the customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "SetName":{
            "title":"Set Name",
            "maxLength":80,
            "type":"string",
            "description":"Reference set name for the billing address.",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustInvKey":{
            "type":"integer",
            "description":"Unique numeric key for the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyTypeDesc":{
            "title":"Party Type Code",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive value of the party type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaidAmount":{
            "title":"Paid Amount",
            "type":"number",
            "description":"Amount collected for the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "CompleteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the invoice is complete.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationDesc":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive value of classification for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustPartyTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the party type for a customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "CustAcctSiteId":{
            "title":"Customer Account Site ID",
            "type":"integer",
            "description":"Identifier of the site for a customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceSystemCd":{
            "maxLength":30,
            "type":"string",
            "description":"Code identifying the receivables application.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceRequestId":{
            "title":"Request ID",
            "type":"integer",
            "description":"The process request identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastSyncDate":{
            "title":"Last Sync Date Time",
            "type":"string",
            "description":"Date on which the invoice data was last synced.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TrxnCustXrefId":{
            "title":"Customer Cross Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"Alpha numeric identifier assigned to customer cross reference record.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceSystemDesc":{
            "title":"Invoice System Code",
            "maxLength":80,
            "type":"string",
            "description":"Description of the receivable application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"Identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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