GET api/Payment/{id}?type={type}

Gets a list of payment by Organization Id and Order Id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Sales Order Id, Return Order Id.	integer	Required
type	List Type.	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Payment

Name	Type	Additional information
UpdateType	string	None.
PaymentId	integer	None.
PaymentMethodId	integer	None.
PaymentMethod	string	None.
OrderId	integer	None.
OrganizationId	integer	None.
PaymentDate	date	None.
CreatedBy	string	None.
CreatedDate	date	None.
UpdatedBy	string	None.
UpdatedDate	date	None.
GlobalId	string	None.
Amount	decimal number	None.
ReferenceNumber	string	None.
Note	string	None.
OpenRegisterId	integer	None.
PaymentStatusId	integer	None.
PaymentStatus	string	None.
AmountReceived	decimal number	None.
AmountOutstanding	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UpdateType": "sample string 1",
    "PaymentId": 2,
    "PaymentMethodId": 1,
    "PaymentMethod": "sample string 3",
    "OrderId": 1,
    "OrganizationId": 1,
    "PaymentDate": "2025-01-15T21:13:50.8723928+00:00",
    "CreatedBy": "sample string 4",
    "CreatedDate": "2025-01-15T21:13:50.8723928+00:00",
    "UpdatedBy": "sample string 5",
    "UpdatedDate": "2025-01-15T21:13:50.8723928+00:00",
    "GlobalId": "sample string 6",
    "Amount": 1.0,
    "ReferenceNumber": "sample string 7",
    "Note": "sample string 8",
    "OpenRegisterId": 1,
    "PaymentStatusId": 1,
    "PaymentStatus": "sample string 9",
    "AmountReceived": 1.0,
    "AmountOutstanding": 1.0
  },
  {
    "UpdateType": "sample string 1",
    "PaymentId": 2,
    "PaymentMethodId": 1,
    "PaymentMethod": "sample string 3",
    "OrderId": 1,
    "OrganizationId": 1,
    "PaymentDate": "2025-01-15T21:13:50.8723928+00:00",
    "CreatedBy": "sample string 4",
    "CreatedDate": "2025-01-15T21:13:50.8723928+00:00",
    "UpdatedBy": "sample string 5",
    "UpdatedDate": "2025-01-15T21:13:50.8723928+00:00",
    "GlobalId": "sample string 6",
    "Amount": 1.0,
    "ReferenceNumber": "sample string 7",
    "Note": "sample string 8",
    "OpenRegisterId": 1,
    "PaymentStatusId": 1,
    "PaymentStatus": "sample string 9",
    "AmountReceived": 1.0,
    "AmountOutstanding": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models">
  <Payment>
    <Amount>1</Amount>
    <AmountOutstanding>1</AmountOutstanding>
    <AmountReceived>1</AmountReceived>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDate>2025-01-15T21:13:50.8723928+00:00</CreatedDate>
    <GlobalId>sample string 6</GlobalId>
    <Note>sample string 8</Note>
    <OpenRegisterId>1</OpenRegisterId>
    <OrderId>1</OrderId>
    <OrganizationId>1</OrganizationId>
    <PaymentDate>2025-01-15T21:13:50.8723928+00:00</PaymentDate>
    <PaymentId>2</PaymentId>
    <PaymentMethod>sample string 3</PaymentMethod>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentStatus>sample string 9</PaymentStatus>
    <PaymentStatusId>1</PaymentStatusId>
    <ReferenceNumber>sample string 7</ReferenceNumber>
    <UpdateType>sample string 1</UpdateType>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDate>2025-01-15T21:13:50.8723928+00:00</UpdatedDate>
  </Payment>
  <Payment>
    <Amount>1</Amount>
    <AmountOutstanding>1</AmountOutstanding>
    <AmountReceived>1</AmountReceived>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDate>2025-01-15T21:13:50.8723928+00:00</CreatedDate>
    <GlobalId>sample string 6</GlobalId>
    <Note>sample string 8</Note>
    <OpenRegisterId>1</OpenRegisterId>
    <OrderId>1</OrderId>
    <OrganizationId>1</OrganizationId>
    <PaymentDate>2025-01-15T21:13:50.8723928+00:00</PaymentDate>
    <PaymentId>2</PaymentId>
    <PaymentMethod>sample string 3</PaymentMethod>
    <PaymentMethodId>1</PaymentMethodId>
    <PaymentStatus>sample string 9</PaymentStatus>
    <PaymentStatusId>1</PaymentStatusId>
    <ReferenceNumber>sample string 7</ReferenceNumber>
    <UpdateType>sample string 1</UpdateType>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDate>2025-01-15T21:13:50.8723928+00:00</UpdatedDate>
  </Payment>
</ArrayOfPayment>