Update a customer invoice data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCustomerInvoices/{TrxnCustInvKey}
Request
Path Parameters
-
TrxnCustInvKey(required): integer(int64)
Unique numeric key for the record.
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
CompleteFlag: string
Maximum Length:
1
Indicates whether the invoice is complete. -
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. -
LastSyncDate: string
(date-time)
Title:
Last Sync Date Time
Date on which the invoice data was last synced. -
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. -
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. -
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. -
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.
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.
Root Schema : publicSectorCustomerInvoices-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.