GET v1/payments/{id}
Gets payment details by id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PaymentName | Description | Type | Additional information |
---|---|---|---|
Id |
Read-only. Payment unique id - auto generated by the system. |
integer |
None. |
TxnNumber |
Read-only. Payment number - auto generated by the system. |
string |
None. |
Customer |
The customer the payment was received from. |
CustomerRef |
Required |
PaymentMethod |
Payment method used for the payment. These are non-processing payment methods. Either PaymentMethod or PaymentProcessingMethod is required. |
IdNamePair |
None. |
PaymentProcessingMethod |
Payment processing method used for the payment. Actual payment processing will be done. PaymentProfile is required. Either PaymentMethod or PaymentProcessingMethod is required. |
IdNamePair |
None. |
PaymentProfile |
Payment profile used for the payment. Required when PaymentProcessingMethod is selected. |
IdNamePair |
None. |
TxnDate |
Date the payment is being made. |
date |
Required |
ReceivedFrom |
The contact person the payment was received from. |
IdNamePair |
None. |
ReferenceNumber |
Reference number for the payment received. |
string |
Required |
Notes |
Notes to provide additional information for the payment. |
string |
None. |
Status |
Read-only. Payment will be created in Approved status when payment method is provided and it will be based on the payment processing results when payment processing method and payment profile is provided. |
IdNamePair |
None. |
PaymentAmount |
The amount of the payment. |
decimal number |
Required |
UnappliedAmount |
Read-only. The amount of the payment that has not been applied yet. |
decimal number |
None. |
Currency |
Read-only. Currency Information. |
Currency |
None. |
BankGLAccount |
This value is only required if the payment directly needs to be deposited into a bank account as per accounting settings. |
IdNamePair |
None. |
ARGLAccount |
Accounts Receivable associated with the payment. Required when more than one AR account is available. |
IdNamePair |
None. |
IsDeposited |
Read-only. Indicates whether the payment has been deposited or not. Deposited payments cannot be voided unless they are undeposited. |
boolean |
None. |
AutoApply |
Indicates whether the payment should be auto applied to open invoices. Will always apply to the oldest open invoice first. |
boolean |
None. |
AppliedToInvoices |
The invoices the payment was applied to. This property is also designated to be used while creating a payment which will apply the payment to the specified invoices. |
Collection of AppliedToTxn |
None. |
AttachmentCount |
Read-only. The number of attachments uploaded to the payment. |
integer |
None. |
DateCreated |
Read-only. The date and time (in company time zone) when the payment was created. |
date |
None. |
CreatedBy |
The person who created the payment. |
IdNamePair |
None. |
LastUpdatedDate |
Read-only. The date and time (in company time zone) when the payment was last updated. |
date |
None. |
LastUpdatedBy |
The person who last updated the payment. |
IdNamePair |
None. |
Reviewed |
Read-only. Indicates whether the payment has been reviewed or not. |
boolean |
None. |
DateReviewed |
Read-only. The date and time (in company time zone) when the payment was reviewed. |
date |
None. |
ReviewedBy |
Read-only. The person who reviewed the payment. |
IdNamePair |
None. |
Response Formats
application/json, text/json
{ "id": 1, "txnNumber": "sample string 2", "customer": { "id": 1, "number": "sample string 2", "name": "sample string 3" }, "paymentMethod": { "id": 1, "name": "sample string 2" }, "paymentProcessingMethod": { "id": 1, "name": "sample string 2" }, "paymentProfile": { "id": 1, "name": "sample string 2" }, "txnDate": "2024-04-25T13:33:02.2676734-04:00", "receivedFrom": { "id": 1, "name": "sample string 2" }, "referenceNumber": "sample string 4", "notes": "sample string 5", "status": { "id": 1, "name": "sample string 2" }, "paymentAmount": 6.0, "unappliedAmount": 7.0, "currency": { "currencyISOCode": "sample string 1", "exchangeRate": 2.0 }, "bankGLAccount": { "id": 1, "name": "sample string 2" }, "arglAccount": { "id": 1, "name": "sample string 2" }, "isDeposited": true, "autoApply": true, "appliedToInvoices": [ { "txnId": 1, "amount": 2.0, "dateApplied": "2024-04-25T13:33:02.2676734-04:00" }, { "txnId": 1, "amount": 2.0, "dateApplied": "2024-04-25T13:33:02.2676734-04:00" } ], "attachmentCount": 10, "dateCreated": "2024-04-25T13:33:02.2676734-04:00", "createdBy": { "id": 1, "name": "sample string 2" }, "lastUpdatedDate": "2024-04-25T13:33:02.2676734-04:00", "lastUpdatedBy": { "id": 1, "name": "sample string 2" }, "reviewed": true, "dateReviewed": "2024-04-25T13:33:02.2676734-04:00", "reviewedBy": { "id": 1, "name": "sample string 2" } }
application/xml, text/xml
<Payment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting"> <ARGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </ARGLAccount> <AppliedToInvoices> <AppliedToTxn> <Amount>2</Amount> <DateApplied>2024-04-25T13:33:02.2676734-04:00</DateApplied> <TxnId>1</TxnId> </AppliedToTxn> <AppliedToTxn> <Amount>2</Amount> <DateApplied>2024-04-25T13:33:02.2676734-04:00</DateApplied> <TxnId>1</TxnId> </AppliedToTxn> </AppliedToInvoices> <AttachmentCount>10</AttachmentCount> <AutoApply>true</AutoApply> <BankGLAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </BankGLAccount> <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </CreatedBy> <Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core"> <d2p1:_x003C_CurrencyISOCode_x003E_k__BackingField>sample string 1</d2p1:_x003C_CurrencyISOCode_x003E_k__BackingField> <d2p1:_x003C_ExchangeRate_x003E_k__BackingField>2</d2p1:_x003C_ExchangeRate_x003E_k__BackingField> </Currency> <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core"> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:Number>sample string 2</d2p1:Number> </Customer> <DateCreated>2024-04-25T13:33:02.2676734-04:00</DateCreated> <DateReviewed>2024-04-25T13:33:02.2676734-04:00</DateReviewed> <Id>1</Id> <IsDeposited>true</IsDeposited> <LastUpdatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </LastUpdatedBy> <LastUpdatedDate>2024-04-25T13:33:02.2676734-04:00</LastUpdatedDate> <Notes>sample string 5</Notes> <PaymentAmount>6</PaymentAmount> <PaymentMethod xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </PaymentMethod> <PaymentProcessingMethod xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </PaymentProcessingMethod> <PaymentProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </PaymentProfile> <ReceivedFrom xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </ReceivedFrom> <ReferenceNumber>sample string 4</ReferenceNumber> <Reviewed>true</Reviewed> <ReviewedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </ReviewedBy> <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField> </Status> <TxnDate>2024-04-25T13:33:02.2676734-04:00</TxnDate> <TxnNumber>sample string 2</TxnNumber> <UnappliedAmount>7</UnappliedAmount> </Payment>