Purchases | Summary Value

Overview

URL	api/{tenantKey}/{orgKey}/purchases/summaryValues
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Received But Not Invoiced List Data
  • GET Get Orders To Receive List Data
  • GET Get Received But Not Invoiced List Count
  • GET Get Orders To Receive List Count
  • GET Get Purchases In Progress Card Data

All Resources

This service uses the following resources:

• NamedSummarizedValue
• OrderToInvoiceResource
• OrderToReceiveResource

GET Operations

GET Get Received But Not Invoiced List Data

Get Purchases Open List.

The following elements are required:

company	(string) Company.
code	(string) Code.

Response:

When successful, the response body contains a list of resources of type 'OrderToInvoiceResource'. See OrderToInvoiceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Orders To Receive List Data

Get Purchases Open List.

The following elements are required:

company	(string) Company.
code	(string) Code.

Response:

When successful, the response body contains a list of resources of type 'OrderToReceiveResource'. See OrderToReceiveResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Received But Not Invoiced List Count

Get the Count of Purchases Orders Received But Not Invoiced.

The following elements are required:

company	(string) Company.
code	(string) Code.

Response:

When successful, the response body contains an item of type 'number'.

Resource URL:

GET Get Orders To Receive List Count

Get the Count of Purchases Orders to Receive.

The following elements are required:

company	(string) Company.
code	(string) Code.

Response:

When successful, the response body contains an item of type 'number'.

Resource URL:

GET Get Purchases In Progress Card Data

Custom operation 'GetPurchasesInProgressCardData'.

The following elements are required:

company

(string) Company.

Response:

When successful, the response body contains a resource of type 'NamedSummarizedValue'. See NamedSummarizedValue.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

NamedSummarizedValue

The following elements are required:

amount	(decimal) Amount.
typeAmount	(string) Type Amount.
fractionDigits	(int) Fraction Digits.
currencySymbol	(string) Currency Symbol.
description	(string) Description.

OrderToInvoiceResource

The following elements are required:

sourceDoc	(string) Source Doc.
documentDate	(DateTime) Document Date.
party	(string) Party.
partyName	(string) Party Name.
amount	(decimal) Amount.
symbol	(string) Symbol.
fractionDigits	(int) Fraction Digits.

The following elements are optional:

sourceDocLink	(string) Source Doc Link.
partyLink	(string) Party Link.
paymentMethod	(string) Payment Method.
operation	(string) Operation.
operationLink	(string) Operation Link.

OrderToReceiveResource

The following elements are required:

sourceDoc	(string) Source Doc.
deliveryDate	(DateTime) Delivery Date.
party	(string) Party.
partyName	(string) Party Name.
openAmount	(decimal) Open Amount.
symbol	(string) Symbol.
fractionDigits	(int) Fraction Digits.

The following elements are optional:

sourceDocLink	(string) Source Doc Link.
partyLink	(string) Party Link.
quantity	(decimal) Quantity.
openQuantity	(decimal) Open Quantity.
operation	(string) Operation.
operationLink	(string) Operation Link.