Read PurchaseReturn
Retrieves the details of a POReturns object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=Status,eq,Created | Invoiced | Shipped;Test CheckBox,eq,0&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=OrderDate,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=OrderDate,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=Deliverto,eq,OAK OR PDX&key=xyzkey List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=Status,eq,Created | Invoiced | Shipped;Test CheckBox,eq,0&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/PurchaseReturn?filter=Status,eq,Created | Invoiced | Shipped;Test CheckBox,eq,0&pageSize=10&key=xyzkey |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
{
"POReturns": {
"POReturn": [{
"POReturnId": "399092",
"POReturnNo": "496",
"POReturnDate": "01-28-2022 05:29:57",
"POReturnDateUTC": "01-24-2020 15:01:35",
"ModifiedDate": "01-28-2022 05:29:57",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"Subject": "Test POreturn",
"VendorId": "9",
"VendorName": "Vendor of Agiliron Inc & Updoer Technology",
"VendorPhone": "888888888",
"VendorEmailAddress": {},
"ContactId": "131",
"ContactFirstName": "Deepak",
"ContactLastName": "Yadav",
"TrackingNo": "812387123",
"Carrier": "UPS",
"ShippingMethod": "2nd Day Air",
"DeliverTo": "OAK",
"AssignedTo": "Admin",
"DefaultCurrency": "Aus Dollar",
"ExchangeRate": "1.00000",
"Status": "Created,Ordered,",
"RelatedPurchaseOrders": {},
"BillTo": "Admin",
"BillingStreet": "123 Sierra Way",
"BillingCity": "San Pablo",
"BillingState": "CA",
"BillingZipCode": "49016",
"BillingCountry": "USA",
"DeliverToName": "Doe",
"ShippingStreet": "1515 Clay Street",
"ShippingCity": "Oakland",
"ShippingState": "CA",
"ShippingZipCode": "94016",
"ShippingCountry": "USA",
"OrderDiscount": "10.00",
"SubTotal": "116.00",
"ShippingCost": "174.00",
"SalesTaxAuthority": {},
"SalesTaxes": "0.00",
"SalesCommission": "0.00",
"GrandTotal": "174.00",
"PaymentLineItems": {
"Payment": [{
"PaymentMethod": "Cash",
"PaymentAmount": "30",
"PaymentDate": "01-28-2022",
"CheckNumber": {},
"CheckWriter": {},
"CreditCardNumber": {},
"CreditCardType": {},
"CreditCardOwner": {},
"CreditCardExpires": {},
"CreditCardSecurityCode": {},
"CreditCardAuthorization": {},
"InvoiceNumber": {},
"CustomerBankAccount": {},
"PaymentEmailAddress": {},
"AmountDue": "0.00"
},
{
"PaymentMethod": "Check",
"PaymentAmount": "50",
"PaymentDate": "01-28-2022",
"CheckNumber": {},
"CheckWriter": {},
"CreditCardNumber": {},
"CreditCardType": {},
"CreditCardOwner": {},
"CreditCardExpires": {},
"CreditCardSecurityCode": {},
"CreditCardAuthorization": {},
"InvoiceNumber": {},
"CustomerBankAccount": {},
"PaymentEmailAddress": {},
"AmountDue": "0.00"
}
]
},
"TermsAndConditions": "test terms",
"Description": "test description",
"ExportToQuickbooks": "0",
"POReturnCustomFields": {
"CustomField": [{
"Name": "Test Text",
"Value": "New text updated1"
},
{
"Name": "Test Number",
"Value": "45561"
}
]
},
"POReturnDetails": {
"OD": [{
"OrderLineNo": "0",
"ProductName": "TestPro",
"ProductCode": "1000003944",
"MatrixSKUCode": "0",
"SerialNo": "0",
"ProductNotes": {},
"ProductsQuantityReceived": "0",
"ProductQty": "3",
"ProductPrice": "20.00",
"ProductDiscount": "10.00",
"ProductTotal": "54.00",
"VendorPartNumber": {}
},
{
"OrderLineNo": "1",
"ProductName": "TestPro1",
"ProductCode": "1000003945",
"MatrixSKUCode": "0",
"SerialNo": "0",
"ProductNotes": {},
"ProductsQuantityReceived": "0",
"ProductQty": "2",
"ProductPrice": "30.00",
"ProductDiscount": "10.00",
"ProductTotal": "54.00",
"VendorPartNumber": {}
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<POReturns>
<POReturn>
<POReturnId>399092</POReturnId>
<POReturnNo>496</POReturnNo>
<POReturnDate>01-28-2022 05:29:57</POReturnDate>
<POReturnDateUTC>01-24-2020 15:01:35</POReturnDateUTC>
<ModifiedDate>01-28-2022 05:29:57</ModifiedDate>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<Subject>Test POreturn</Subject>
<VendorId>9</VendorId>
<VendorName>Vendor of Agiliron Inc & Updoer Technology</VendorName>
<VendorPhone>888888888</VendorPhone>
<VendorEmailAddress></VendorEmailAddress>
<ContactId>131</ContactId>
<ContactFirstName>Deepak</ContactFirstName>
<ContactLastName>Yadav</ContactLastName>
<TrackingNo>812387123</TrackingNo>
<Carrier>UPS</Carrier>
<ShippingMethod>2nd Day Air</ShippingMethod>
<DeliverTo>OAK</DeliverTo>
<AssignedTo>Admin</AssignedTo>
<DefaultCurrency>Aus Dollar</DefaultCurrency>
<ExchangeRate>1.00000</ExchangeRate>
<Status>Created,Ordered,</Status>
<RelatedPurchaseOrders></RelatedPurchaseOrders>
<BillTo>Admin</BillTo>
<BillingStreet>123 Sierra Way</BillingStreet>
<BillingCity>San Pablo</BillingCity>
<BillingState>CA</BillingState>
<BillingZipCode>94016</BillingZipCode>
<BillingCountry>USA</BillingCountry>
<DeliverToName>Doe</DeliverToName>
<ShippingStreet>1515 Clay Street</ShippingStreet>
<ShippingCity>Oakland</ShippingCity>
<ShippingState>CA</ShippingState>
<ShippingZipCode>94016</ShippingZipCode>
<ShippingCountry>USA</ShippingCountry>
<OrderDiscount>10.00</OrderDiscount>
<SubTotal>116.00</SubTotal>
<ShippingCost>174.00</ShippingCost>
<SalesTaxAuthority></SalesTaxAuthority>
<SalesTaxes>0.00</SalesTaxes>
<SalesCommission>0.00</SalesCommission>
<GrandTotal>174.00</GrandTotal>
<PaymentLineItems>
<Payment>
<PaymentMethod>Cash</PaymentMethod>
<PaymentAmount>30</PaymentAmount>
<PaymentDate>01-28-2022</PaymentDate>
<CheckNumber></CheckNumber>
<CheckWriter></CheckWriter>
<CreditCardNumber></CreditCardNumber>
<CreditCardType></CreditCardType>
<CreditCardOwner></CreditCardOwner>
<CreditCardExpires></CreditCardExpires>
<CreditCardSecurityCode></CreditCardSecurityCode>
<CreditCardAuthorization></CreditCardAuthorization>
<InvoiceNumber></InvoiceNumber>
<CustomerBankAccount></CustomerBankAccount>
<PaymentEmailAddress></PaymentEmailAddress>
<AmountDue>0.00</AmountDue>
</Payment>
<Payment>
<PaymentMethod>Check</PaymentMethod>
<PaymentAmount>50</PaymentAmount>
<PaymentDate>01-28-2022</PaymentDate>
<CheckNumber></CheckNumber>
<CheckWriter></CheckWriter>
<CreditCardNumber></CreditCardNumber>
<CreditCardType></CreditCardType>
<CreditCardOwner></CreditCardOwner>
<CreditCardExpires></CreditCardExpires>
<CreditCardSecurityCode></CreditCardSecurityCode>
<CreditCardAuthorization></CreditCardAuthorization>
<InvoiceNumber></InvoiceNumber>
<CustomerBankAccount></CustomerBankAccount>
<PaymentEmailAddress></PaymentEmailAddress>
<AmountDue>0.00</AmountDue>
</Payment>
</PaymentLineItems>
<TermsAndConditions>test terms</TermsAndConditions>
<Description>test description</Description>
<ExportToQuickbooks>0</ExportToQuickbooks>
<POReturnCustomFields>
<CustomField>
<Name>Test Text</Name>
<Value>New text updated1</Value>
</CustomField>
<CustomField>
<Name>Test Number</Name>
<Value>45561</Value>
</CustomField>
</POReturnCustomFields>
<POReturnDetails>
<OD>
<OrderLineNo>0</OrderLineNo>
<ProductName>TestPro</ProductName>
<ProductCode>1000003944</ProductCode>
<MatrixSKUCode>0</MatrixSKUCode>
<SerialNo>0</SerialNo>
<ProductNotes></ProductNotes>
<ProductsQuantityReceived>0</ProductsQuantityReceived>
<ProductQty>3</ProductQty>
<ProductPrice>20.00</ProductPrice>
<ProductDiscount>10.00</ProductDiscount>
<ProductTotal>54.00</ProductTotal>
<VendorPartNumber></VendorPartNumber>
</OD>
<OD>
<OrderLineNo>1</OrderLineNo>
<ProductName>TestPro1</ProductName>
<ProductCode>1000003945</ProductCode>
<MatrixSKUCode>0</MatrixSKUCode>
<SerialNo>0</SerialNo>
<ProductNotes></ProductNotes>
<ProductsQuantityReceived>0</ProductsQuantityReceived>
<ProductQty>2</ProductQty>
<ProductPrice>30.00</ProductPrice>
<ProductDiscount>10.00</ProductDiscount>
<ProductTotal>54.00</ProductTotal>
<VendorPartNumber></VendorPartNumber>
</OD>
</POReturnDetails>
</POReturn>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</POReturns>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="PurchaseReturn">
<method name="GET">
<resource path="{filter}">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated 21 days ago