--- title: "Retrieve all payments" method: GET path: "/api/v2/organizations/{orgSlug}/payments" tags: ["Payments"] --- # Retrieve all payments `GET /api/v2/organizations/{orgSlug}/payments` Retrieve a list of payments based on provided filters Required scopes: `flex.billing.payments.read` ## Path parameters - `orgSlug` string, required ## Query parameters - `_id` string - `member` string - `company` string - `date` string - `dueDate` string - `number` string - `location` string - `documentType` 'creditNote' | 'invoice' | 'overpayment' | 'paymentCharge' — The type of the document. It could be either invoice, creditNote, or overpayment. If omitted, invoice is assumed. - `status` string - `modifiedAt` string - `createdAt` string - `$select` string - `$cursorNext` string - `$cursorPrev` string - `$limit` number - `$sort` string ## Response `200` - object - `rangeStart` number - `rangeEnd` number - `cursorNext` string - `cursorPrev` string - `results` PaymentResultDto[] - `properties` object — An object that contains all custom properties that can be applied to the item. - `_id` string — The id of the payment. - `number` string — The document number for the payment. - `documentType` 'creditNote' | 'invoice' | 'overpayment' | 'paymentCharge' — The type of the document. It could be either invoice, creditNote, or overpayment. If omitted, invoice is assumed. - `date` string — The issue date of the payment. - `dueDate` string — The due date of the payment. - `company` string — A reference to the company the payment is issued for. - `member` string — A reference to the member or individual the payment is issued for. - `location` string — A reference to the location the payment is issued by. - `reference` string — Additional data describing the payment. It could be any string value. - `taxType` 'included' | 'excluded' | 'noTax' — The type of the tax calculation for the payment. It could be excluded, included or noTax. - `allocations` CreditAllocationResultDto[] — A list of credit allocations. Each allocation has amount and target. - `_id` string — The id of the credit allocation. - `target` string — If payment is an invoice, a reference to the credit note, sourcing the credit. If payment is a credit note, a reference to the invoice the credit is allocated to. - `amount` number — The allocated amount. - `documentType` 'creditNote' | 'invoice' | 'overpayment' | 'paymentCharge' — The type of the document. It could be either invoice, creditNote, or overpayment. If omitted, invoice is assumed. - `accounting` AccountingResultDto - `provider` string — The name of the accounting provider. - `providerId` string — The id of the payment in the accounting provider. - `externalOrgId` string — The organization id in the accounting provider. - `deepLink` string — A deep link to the payment in the accounting provider. - `lastSync` string — The date of the last sync of the payment with the accounting integration. - `error` string — An error message with more details about the reason of the failure. - `lines` LineItemDto[] — A list of payment line items. - `taxPercent` number — The tax percent applied to the line item. - `taxAmount` number — The tax amount applied to the line item. - `price` number — The total price as described in the system. - `discountAmount` number — The calculated discount amount based on the discount set in the payment. - `unitPrice` number — Based on the quantity of the line item, this is the price of a single unit. - `baseUnitPrice` number — Based on the quantity of the line item, this is the price of a single unit in the base currency. - `subTotal` number — The subtotal of the line item (including tax). - `baseTotal` number — The total price of the line item in the base currency (including discount). - `total` number — The total for the line item (including tax). - `convertedAmounts` CalculatedLineStatsDto - `taxPercent` number — The tax percent applied to the line item. - `taxAmount` number — The tax amount applied to the line item. - `price` number — The total price as described in the system. - `discountAmount` number — The calculated discount amount based on the discount set in the payment. - `unitPrice` number — Based on the quantity of the line item, this is the price of a single unit. - `baseUnitPrice` number — Based on the quantity of the line item, this is the price of a single unit in the base currency. - `subTotal` number — The subtotal of the line item (including tax). - `baseTotal` number — The total price of the line item in the base currency (including discount). - `total` number — The total for the line item (including tax). - `description` string — Description of the line item. - `account` string — A reference to the account the line item is allocated to. - `plan` string — A reference to the plan the line item is for. - `fee` string — A reference to the fee the line item is for. - `location` string — A reference to the location the line item is for. - `membership` string — A reference to the membership the line item is for. @deprecated Use memberships array instead. - `taxRate` string — A reference to the taxRate the line item is for. - `discount` number — Based on the quantity of the line item, this is the total discount that applied. - `unitDiscount` number — Based on the quantity of the line item, this is the single discount of a unit. - `quantity` number — The quantity of items described in the line item. - `startDate` string — The start date of the billing period. - `endDate` string — The end date of the billing period. - `addOns` LineItemAddonDto - `name` string — The name of the addon. - `unitPrice` number — The unit price of the addon. - `description` string — The description of the addon. - `fees` string[] — An array of fee references from the original lines that were merged into this invoice line. - `memberships` string[] — An array of membership references from the original lines that were merged into this invoice line. - `processingFeeLine` LineItemDto - `taxPercent` number — The tax percent applied to the line item. - `taxAmount` number — The tax amount applied to the line item. - `price` number — The total price as described in the system. - `discountAmount` number — The calculated discount amount based on the discount set in the payment. - `unitPrice` number — Based on the quantity of the line item, this is the price of a single unit. - `baseUnitPrice` number — Based on the quantity of the line item, this is the price of a single unit in the base currency. - `subTotal` number — The subtotal of the line item (including tax). - `baseTotal` number — The total price of the line item in the base currency (including discount). - `total` number — The total for the line item (including tax). - `convertedAmounts` CalculatedLineStatsDto - `taxPercent` number — The tax percent applied to the line item. - `taxAmount` number — The tax amount applied to the line item. - `price` number — The total price as described in the system. - `discountAmount` number — The calculated discount amount based on the discount set in the payment. - `unitPrice` number — Based on the quantity of the line item, this is the price of a single unit. - `baseUnitPrice` number — Based on the quantity of the line item, this is the price of a single unit in the base currency. - `subTotal` number — The subtotal of the line item (including tax). - `baseTotal` number — The total price of the line item in the base currency (including discount). - `total` number — The total for the line item (including tax). - `description` string — Description of the line item. - `account` string — A reference to the account the line item is allocated to. - `plan` string — A reference to the plan the line item is for. - `fee` string — A reference to the fee the line item is for. - `location` string — A reference to the location the line item is for. - `membership` string — A reference to the membership the line item is for. @deprecated Use memberships array instead. - `taxRate` string — A reference to the taxRate the line item is for. - `discount` number — Based on the quantity of the line item, this is the total discount that applied. - `unitDiscount` number — Based on the quantity of the line item, this is the single discount of a unit. - `quantity` number — The quantity of items described in the line item. - `startDate` string — The start date of the billing period. - `endDate` string — The end date of the billing period. - `addOns` LineItemAddonDto - `name` string — The name of the addon. - `unitPrice` number — The unit price of the addon. - `description` string — The description of the addon. - `fees` string[] — An array of fee references from the original lines that were merged into this invoice line. - `memberships` string[] — An array of membership references from the original lines that were merged into this invoice line. - `taxAmounts` TaxAmountDto[] — A list of payment tax amounts. - `percent` number — The tax percent for the group. - `total` number — The tax total for the group. - `taxRate` string — A reference to the taxRate the group is for. - `subTotal` number — The total of the payment before tax. - `amount` number — The total of the payment after tax and discount. - `payableAmount` number — Total amount due for this payment. Voided and paid payments have payableAmount of 0. - `accounting` AccountingResultDto - `provider` string — The name of the accounting provider. - `providerId` string — The id of the payment in the accounting provider. - `externalOrgId` string — The organization id in the accounting provider. - `deepLink` string — A deep link to the payment in the accounting provider. - `lastSync` string — The date of the last sync of the payment with the accounting integration. - `error` string — An error message with more details about the reason of the failure. - `baseTotal` number — The base total amount of the payment. - `total` number — The total amount of the payment. - `paidAmount` number — The total amount paid for the payment. - `pendingAmount` number — The total amount pending for the payment. - `allocatedAmount` number — The total amount allocated for the payment. - `currency` string — The currency of the payment. - `currencyConversionRate` number — The conversion rate for the currency of the payment. - `isFailed` boolean — Determines whether the payment is considered as failed. - `isPaid` boolean — Determines whether the payment is considered as paid. - `isSent` boolean — Shows if the payment has been sent. - `status` 'voided' | 'failed' | 'draft' | 'pending' | 'refunded' | 'paid' | 'awaiting_payment' | 'partially_paid' — The status of the payment. - `chargeMethod` string — The charge method of the payment. - `createdAt` string — The date when the payment has been created at. - `createdBy` string — The user that created the payment. - `modifiedAt` string — The date when the payment has been modified for the last time. Note that adding/removing charges and credit allocations are considered modifications to both the invoice and the credit note/overpayment. - `modifiedBy` string — The user that did the last modification to the payment. Before the first modification, this field equals to the createdBy field. --- [API](https://skmtc.dev/officernd/apis/authentication-api.md) · [All operations](https://skmtc.dev/officernd/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/officernd/authentication-api/revisions/6bcd33dc648e/schema)