Get all invoices

get

/fscmRestApi/resources/11.13.18.05/invoicesForLandedCostCharges

Request

Query Parameters
  • 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).
  • 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
  • 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
      Finder Variables
      • InvoiceId; integer;
      • InvoiceLineNumber; string;
    • findInvoicesForCharges
      Finder Variables
      • bindAssociationMode; string;
      • bindAssociationStatus; string;
      • bindChargeBU; string;
      • bindChargeName; string;
      • bindChargeReferenceName; string;
      • bindChargeReferencePredefined; string;
      • bindInvoiceAmount; number;
      • bindInvoiceCreationDate; string;
      • bindInvoiceCurrency; string;
      • bindInvoiceLineNumber; string;
      • bindInvoiceNrTaxAmount; number;
      • bindInvoiceNumber; string;
      • bindMissingChargeNames; string;
      • bindMissingChargeReferences; string;
      • bindProcurementBU; string;
      • bindReferenceValueDate; string;
      • bindReferenceValueNumber; number;
      • bindReferenceValueText; string;
      • bindSupplier; string;
      • bindSupplierSite; string;
      • bindTradeOperationName; string;
      • bindTradeOperationNumber; string;
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AssociationMode; string
    • AssociationModeCode; number
    • AssociationStatus; string
    • ChargeBU; string
    • ChargeBUId; integer
    • ChargeCode; string
    • ChargeId; integer
    • ChargeName; string
    • InvoiceAmount; number
    • InvoiceCreationDate; string
    • InvoiceCurrency; string
    • InvoiceCurrencyCode; string
    • InvoiceId; integer
    • InvoiceLineNumber; string
    • InvoiceLineType; string
    • InvoiceNonrecoverableTaxAmount; number
    • InvoiceNumber; string
    • MissingChargeReferences; string
    • ProcurementBU; string
    • ProcurementBUId; integer
    • Supplier; string
    • SupplierId; integer
    • SupplierSite; string
    • SupplierSiteId; integer
    • TradeOperationName; string
    • TradeOperationNumber; string
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : invoicesForLandedCostCharges
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : invoicesForLandedCostCharges-item-response
Type: object
Show Source
Nested Schema : Charge References
Type: array
Title: Charge References
The Charge References resource manages the charge references on the charge used for an invoice association.
Show Source
Nested Schema : invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all invoices.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges"

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS007",
		"InvoiceID": 300100089897318,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17",
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "03",
		"SupplierSiteID": 1712,
		"TradeOperationName": "Exp Dest",
		"TradeOperationNumber": "7",
		...
	},
	...
	]
	...
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get all landed cost charge references associated with a landed cost charge:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07F41616600000001310000000EACED00057708000110F07F4161660000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines"

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"ChargeReferenceName": "Freight_Ref",
		"ChargeReferenceTypeID": 300100071793244,
		"ChargeReferencePredefined": true,
		"ChargeReferenceValueDataType": "Date",
		"ChargeRefValueDataTypeCode": null,
		"ReferenceValueNumber": null,
		"ReferenceValueDate": null,
		"ReferenceValueText": null,
		"InvoiceChargeReferenceID": null,
		"ProcurementBU": null,
		"ProcurementBUID": null,
		"ChargeReferenceName": null,
		"UserComment": null,
		"InvalidAttributeDerivation": null,
		"ChargeRefDataType": null,   
		...
	},
	...
	]
	...
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resource to get all invoices for landed cost with charge references:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindMissingChargeReferences=false"

Example 3 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS007",
		"InvoiceID": 300100089897318,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "03",
		"SupplierSiteID": 1712,
		"TradeOperationName": "Exp Dest",
		"TradeOperationNumber": "7",
		...
	},
	...
	]
	...
}          

Example 4 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by procurement business unit and invoice status:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindProcurementBU=Vision Operations;bindAssociationStatus=New"

Example 4 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS007",
		"InvoiceID": 300100089897318,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "03",
		"SupplierSiteID": 1712,
		"TradeOperationName": "Exp Dest",
		"TradeOperationNumber": "7",
		...
	},
	...
	]
	...
}           

Example 5 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by association mode:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindAssociationMode=Automatic"

Example 5 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Freight",
		"ChargeCode": "SS_Freight",
		"ChargeID": 300100071793249,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "zR13OTBI_P2P_LCM_001",
		"InvoiceID": 300100100238973,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/27/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "zBIA_Supplier_02",
		"SupplierID": 300100000344256,
		"SupplierSite": "zBIA_Supplier_0",
		"SupplierSiteID": 300100000344273,
		"TradeOperationName": "zR13OTBI_TR003",
		"TradeOperationNumber": "8",
		...
	},
	...
	]
	...
}           

Example 6 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by charge name:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindChargeName=SS_Freight"

Example 6 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Freight",
		"ChargeCode": "SS_Freight",
		"ChargeID": 300100071793249,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "zR13OTBI_P2P_LCM_001",
		"InvoiceID": 300100100238973,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/27/17",
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "zBIA_Supplier_02",
		"SupplierID": 300100000344256,
		"SupplierSite": "zBIA_Supplier_0",
		"SupplierSiteID": 300100000344273,
		"TradeOperationName": "zR13OTBI_TR003",
		"TradeOperationNumber": "8",
		...
	},
	...
	]
	...
}           

Example 7 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by invoice currency:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindInvoiceCurrency=US Dollar"

Example 7 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Freight",
		"ChargeCode": "SS_Freight",
		"ChargeID": 300100071793249,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "zR13OTBI_P2P_LCM_001",
		"InvoiceID": 300100100238973,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/27/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "zBIA_Supplier_02",
		"SupplierID": 300100000344256,
		"SupplierSite": "zBIA_Supplier_0",
		"SupplierSiteID": 300100000344273,
		"TradeOperationName": "zR13OTBI_TR003",
		"TradeOperationNumber": "8",
		...
	},
	...
	]
	...
}           

Example 8 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by invoice number and invoice line number:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindInvoiceNumber=SS002,bindInvoiceLineNumber=1"

Example 8 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "No match",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "SS002",
		"InvoiceID": 300100071634153,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 2000,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "03/12/15", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 9 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by invoice non-recoverable tax amount:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindInvoiceNonrecoverableTaxAmount=67.54"

Example 9 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "No match",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "SS002",
		"InvoiceID": 300100071634153,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 2000,
		"InvoiceNonrecoverableTaxAmount": "67.54                       
		""InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "03/12/15", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 10 cURL Command

Use the following cURL command to submit a request on the REST resource get invoices for landed cost by supplier and supplier site:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindSupplier=PennyPack Systems,bindSupplierSite=FRESNO"

Example 10 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "No match",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "SS002",
		"InvoiceID": 300100071634153,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 2000,
		"InvoiceNonrecoverableTaxAmount": "67.54"                      
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "03/12/15", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 11 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by charge reference name:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindChargeReferenceName=Handling_Ref"

Example 11 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS007",
		"InvoiceID": 300100089897318,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "-2/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "03",
		"SupplierSiteID": 1712,
		"TradeOperationName": "Exp Dest",
		"TradeOperationNumber": "7",
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :4                                                                        
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 12 cURL Command

Use the following cURL command to submit a request on the REST resource get invoices for landed cost by reference value text:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindRefValueText=SS1510"

Example 12 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "New",
		"ChargeName": "SS_Discount",
		"ChargeCode": "SS_Discount",
		"ChargeID": 300100071793246,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS003",
		"InvoiceID": 300100071634155,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 100,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "03/12/15", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :1                                                                       
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 13 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by predefined flag:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindChargeRefPredefined=true"

Example 13 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": "Automatic",
		"AssociationModeCode": 1,
		"AssociationStatus": "Associated",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "false",
		"InvoiceNumber": "SS007",
		"InvoiceID": 300100089897318,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 75,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "03",
		"SupplierSiteID": 1712,
		"TradeOperationName": "Exp Dest",
		"TradeOperationNumber": "7",
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :4                                                                        
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 14 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by procurement business unit and shows only invoices missing charge names:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindProcurementBU=Vision Operations,bindMissingChargeNames=true"

Example 14 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "New",
		"ChargeName": null,
		"ChargeCode": null,
		"ChargeID": null,
		"ChargeBU": null,
		"ChargeBUID": null,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "LCMINVREL12CDRM001",
		"InvoiceID": 300100089904233,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 150,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :1                                                                       
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 15 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by procurement business unit and shows only invoices missing reference types:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindProcurementBU=Vision Operations,bindMissingChargeReferences=true"

Example 15 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "No match",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "SS002",
		"InvoiceID": 300100071634153,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 2000,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "03/12/15", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :2                                                                      
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}

Example 16 cURL Command

Use the following cURL command to submit a request on the REST resource to get invoices for landed cost by invoice creation date that is in the mm/dd/yy format:

curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges?finder=findInvoicesForCharges;bindInvoiceCreationDate=02/23/17"

Example 16 Response Body

The following shows an example of the response body in JSON format.

{
	"items":[
	{
		"AssociationMode": null,
		"AssociationModeCode": null,
		"AssociationStatus": "No match",
		"ChargeName": "SS_Handling",
		"ChargeCode": "SS_Handling",
		"ChargeID": 300100071793255,
		"ChargeBU": "Vision Operations",
		"ChargeBUID": 204,
		"MissingChargeReferences": "true",
		"InvoiceNumber": "SS002",
		"InvoiceID": 300100071634153,
		"InvoiceLineNumber": "1",
		"InvoiceLineType": "ITEM",
		"InvoiceAmount": 2000,
		"InvoiceNonrecoverableTaxAmount": 0,
		"InvoiceCurrency": "US Dollar",
		"InvoiceCurrencyCode": "USD",
		"InvoiceCreationDate": "02/23/17", 
		"ProcurementBU": "Vision Operations",
		"ProcurementBUID": 204,
		"Supplier": "PennyPack Systems",
		"SupplierID": 21,
		"SupplierSite": "FRESNO",
		"SupplierSiteID": 1969,
		"TradeOperationName": null,
		"TradeOperationNumber": null,
		"links":[
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
			"name": "invoicesForLandedCostCharges",
			"kind": "item",
		},
		{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
			"name": "landedCostChargeReferencesForInvoiceLines",
			"kind": "collection"
		}
		]
	}
	],
	"count": :2                                                                      
	"hasMore": false,
	"limit": 25,
	"offset": 0,
}
Back to Top