# Retrieve a payment breakdown

GET https://api.letsdeel.com/rest/v2/payments/{payment_id}/breakdown

Get a full breakdown of a payment made to Deel. Breakdown will include individual invoices and Deel fee as line items.
 **Token scopes**: `accounting:read`

Reference: https://developer.deel.com/api/reference/endpoints/accounting/retrieve-a-payment-breakdown

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: Deel HRIS SCIM API
  version: 1.0.0
paths:
  /payments/{payment_id}/breakdown:
    get:
      operationId: retrieve-a-payment-breakdown
      summary: Retrieve a payment breakdown
      description: >-
        Get a full breakdown of a payment made to Deel. Breakdown will include
        individual invoices and Deel fee as line items.
         **Token scopes**: `accounting:read`
      tags:
        - subpackage_accounting
      parameters:
        - name: payment_id
          in: path
          description: Unique identifier for the payment to retrieve the breakdown.
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >
            ## Authentication

            The Deel API uses bearer tokens to authenticate requests. All API
            calls must be made over HTTPS — calls over plain HTTP or without
            authentication will fail.


            ```curl

            curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
              -H 'Authorization: Bearer YOUR-TOKEN-HERE'
            ```


            [Learn more about authentication](/api/authentication)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Accounting_retrieveAPaymentBreakdown_Response_200
        '400':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '401':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '403':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '404':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
        '500':
          description: Operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorContainer'
servers:
  - url: https://api.letsdeel.com/rest/v2
  - url: https://api-staging.letsdeel.com/rest/v2
components:
  schemas:
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1:
      type: string
      enum:
        - ''
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId:
      oneOf:
        - type: string
          format: uuid
        - $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1
      description: >-
        Unique identifier for the group associated with this payment. Empty for
        organization-level payments, individual payments, and standalone service
        fees that are not associated with a specific group.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency:
      type: string
      enum:
        - hourly
        - daily
        - weekly
        - biweekly
        - semimonthly
        - monthly
        - custom
        - ''
      description: >-
        Work unit scale from the contractor's work statement. Indicates how work
        is measured and reported (hourly, daily, weekly, monthly, or custom
        units). Empty for contracts with fixed payments that don't require work
        quantity tracking, such as milestone-based contracts and consulting
        agreements.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1:
      type: string
      enum:
        - ''
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate:
      oneOf:
        - type: string
          format: date-time
        - $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1
      description: >-
        Date when the work report was approved by designated approvers. Empty
        for payments that don't require work report approval, such as service
        fees, management fees, and automated payments.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType:
      type: string
      enum:
        - milestones
        - time_based
        - ongoing_time_based
        - pay_as_you_go_time_based
        - commission
        - payg_milestones
        - payg_tasks
        - eor
        - peo
        - peo_csa
        - unknown
        - employee
        - global_payroll
        - shield_msa
        - gp_client_agreement
        - ep_client_agreement
        - power_of_attorney
        - debt_authorization
        - hris_direct_employee
        - hris_service_agreement
        - hofy_standalone_payment
        - wework_standalone_payment
        - travel_insurance_standalone_payment
        - health_insurance_standalone_payment
        - prepaid_billing
        - missing_saas_fees
        - one_off_service_fee
        - eor_management_fee
        - eor_one_off_management_fee
        - engage_monthly_subscription_fee
        - ats_subscription_fee
        - benefits_admin_monthly_platform_fee
        - contractor_outside_deel
        - late_payment_fee
        - background_check_standalone_payment
        - peo_service_fee
        - payment_processing_fee
        - deel_percentage_fee
        - netx_fee
        - prepaid_funding_statement
        - one_off_mobility_service_fee
        - prepaid_billing_expired_credits
        - implementation_delay
        - managed_hr_monthly_subscription_fee
        - expense_card
        - anon_report_fee
      description: >-
        Type of contract this payment relates to. Determines the nature of the
        work relationship and payment structure.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1:
      type: string
      enum:
        - ''
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate:
      oneOf:
        - type: string
          format: date-time
        - $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1
      description: >-
        Start date of the contract. Empty for service agreements and fee-related
        contracts (such as equipment payments, insurance payments, and
        management fees) that don't have traditional contract start dates.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1:
      type: string
      enum:
        - ''
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier:
      oneOf:
        - type: string
          format: uuid
        - $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1
      description: >-
        Unique identifier for the worker. May be empty for certain contract
        types such as service agreements and fees.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier
    PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        date:
          type: string
          format: date-time
          description: Date associated with the payment breakdown.
        work:
          type: string
          description: >-
            Base payment amount for work performed, including regular
            salary/wages and off-cycle payments.
        bonus:
          type: string
          description: Additional bonus payment amount awarded to the worker.
        total:
          type: string
          description: Total payment due for this breakdown item.
        others:
          type: string
          description: Other payment amounts.
        currency:
          type: string
          description: Currency code for this payment.
        expenses:
          type: string
          description: Expenses related to the payment.
        group_id:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId
          description: >-
            Unique identifier for the group associated with this payment. Empty
            for organization-level payments, individual payments, and standalone
            service fees that are not associated with a specific group.
        overtime:
          type: string
          description: Overtime payment amount.
        pro_rata:
          type: string
          description: Pro-rated payment amount.
        approvers:
          type: string
          description: >-
            Comma-separated list of names of people who approved this payment.
            May be empty if no approvals were required or recorded.
        frequency:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency
          description: >-
            Work unit scale from the contractor's work statement. Indicates how
            work is measured and reported (hourly, daily, weekly, monthly, or
            custom units). Empty for contracts with fixed payments that don't
            require work quantity tracking, such as milestone-based contracts
            and consulting agreements.
        adjustment:
          type: string
          description: Adjustment amount for the payment.
        deductions:
          type: string
          description: Deductions from the payment.
        invoice_id:
          type: string
          description: Unique identifier of this resource.
        commissions:
          type: string
          description: Commissions included in the payment.
        approve_date:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate
          description: >-
            Date when the work report was approved by designated approvers.
            Empty for payments that don't require work report approval, such as
            service fees, management fees, and automated payments.
        payment_date:
          type: string
          format: date-time
          description: Date when the payment was made.
        contract_type:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType
          description: >-
            Type of contract this payment relates to. Determines the nature of
            the work relationship and payment structure.
        processing_fee:
          type: string
          description: Processing fee amount applied to the payment.
        contract_country:
          type: string
          description: Country where the contract is established.
        contractor_email:
          type: string
          description: Email address of the worker.
        payment_currency:
          type: string
          description: Currency in which the payment was processed.
        contract_start_date:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate
          description: >-
            Start date of the contract. Empty for service agreements and
            fee-related contracts (such as equipment payments, insurance
            payments, and management fees) that don't have traditional contract
            start dates.
        general_ledger_account:
          type: string
          description: >-
            General ledger account code or name for accounting purposes. May be
            configured at the group, company, or organization level. Empty if
            not configured.
        total_payment_currency:
          type: string
          description: Total payment in the payment currency.
        contractor_employee_name:
          type: string
          description: Name of the worker.
        contractor_unique_identifier:
          $ref: >-
            #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier
          description: >-
            Unique identifier for the worker. May be empty for certain contract
            types such as service agreements and fees.
      title: >-
        PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems
    Accounting_retrieveAPaymentBreakdown_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: >-
              #/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems
      title: Accounting_retrieveAPaymentBreakdown_Response_200
    ApiErrorRequest:
      type: object
      properties:
        method:
          type: string
          description: The HTTP method of the failed request
        url:
          type: string
          description: The relative URL of the failed request
        status:
          type: number
          format: double
          description: The status code of the response
        api_req_id:
          type: string
          description: The request ID of the failed request
        docs:
          type: string
          description: >-
            A link to the official documentation for the requested endpoint
            resource
        source:
          type: string
          description: The source handler which produced the returned error
        code:
          type: number
          format: double
          description: The code of the source handler which produced the returned error
      title: ApiErrorRequest
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: A description of the returned error
        path:
          type: string
          description: The JSON path where input validation failed
      title: ApiError
    ApiErrorContainer:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ApiErrorRequest'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiError'
      title: ApiErrorContainer
  securitySchemes:
    deelToken:
      type: http
      scheme: bearer
      description: >
        ## Authentication

        The Deel API uses bearer tokens to authenticate requests. All API calls
        must be made over HTTPS — calls over plain HTTP or without
        authentication will fail.


        ```curl

        curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
          -H 'Authorization: Bearer YOUR-TOKEN-HERE'
        ```


        [Learn more about authentication](/api/authentication)
    oauth2:
      type: http
      scheme: bearer
      description: >-
        Standard OAuth2 security scheme based on
        https://swagger.io/docs/specification/authentication/

```

## SDK Code Examples

```python
import requests

url = "https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/v2/payments/YJdYFAA586JYf8A324T57/breakdown")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```