Payments

Create Payments in batch

Changed on

Create multiple payments in a single request. Each item is processed independently, so some may be created while others fail; the response returns 200 with one result per item, in the order the items were sent. The maximum number of items accepted per request depends on the connector.

post/accounting/payments/batch

Request

  • Base URL: https://unify.apideck.com
  • URL: https://unify.apideck.com/accounting/payments/batch
  • Auth: API key in header Authorization

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

Example request

{
  "items": [
    {
      "_ref": "item-1",
      "data": {
        "currency": "USD",
        "currency_rate": 0.69,
        "total_amount": 49.99,
        "reference": "123456",
        "payment_method": "cash",
        "payment_method_reference": "123456",
        "payment_method_id": "12345",
        "accounts_receivable_account_type": "Account",
        "accounts_receivable_account_id": "123456",
        "account": {
          "id": "123456",
          "name": "Bank account",
          "nominal_code": "N091",
          "code": "453",
          "parent_id": "123456",
          "display_id": "123456"
        },
        "transaction_date": "2021-05-01T12:00:00.000Z",
        "customer": {
          "id": "12345",
          "display_id": "CUST00101",
          "display_name": "Windsurf Shop",
          "name": "Windsurf Shop",
          "company_name": "The boring company",
          "email": "boring@boring.com"
        },
        "supplier": {
          "id": "12345",
          "display_id": "SUPP00101",
          "display_name": "Windsurf Shop",
          "company_name": "The boring company",
          "address": {
            "id": "123",
            "type": "primary",
            "string": "25 Spring Street, Blackburn, VIC 3130",
            "name": "HQ US",
            "line1": "Main street",
            "line2": "apt #",
            "line3": "Suite #",
            "line4": "delivery instructions",
            "line5": "Attention: Finance Dept",
            "street_number": "25",
            "city": "San Francisco",
            "state": "CA",
            "postal_code": "94104",
            "country": "US",
            "latitude": "40.759211",
            "longitude": "-73.984638",
            "county": "Santa Clara",
            "contact_name": "Elon Musk",
            "salutation": "Mr",
            "phone_number": "111-111-1111",
            "fax": "122-111-1111",
            "email": "elon@musk.com",
            "website": "https://elonmusk.com",
            "notes": "Address notes or delivery instructions.",
            "row_version": "1-12345"
          }
        },
        "company_id": "12345",
        "subsidiary": {
          "id": "12345",
          "display_id": "123456",
          "name": "Acme Inc."
        },
        "reconciled": true,
        "status": "authorised",
        "type": "accounts_receivable",
        "allocations": [
          {
            "id": "123456",
            "code": "N091",
            "amount": 49.99,
            "allocation_id": "123456"
          }
        ],
        "note": "Some notes about this transaction",
        "number": "123456",
        "tracking_categories": [
          {
            "id": "123456",
            "code": "100",
            "name": "New York",
            "parent_id": "123456",
            "parent_name": "New York"
          }
        ],
        "custom_fields": [
          {
            "id": "2389328923893298",
            "name": "employee_level",
            "ref_name": "Marketing",
            "description": "Employee Level",
            "value": "Uses Salesforce and Marketo"
          }
        ],
        "row_version": "1-12345",
        "display_id": "123456",
        "pass_through": [
          {
            "extend_paths": [
              {
                "path": "$.nested.property",
                "value": {
                  "TaxClassificationRef": {
                    "value": "EUC-99990201-V1-00020000"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Response

Payments batch processed

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "quickbooks",
  "resource": "payments",
  "operation": "add",
  "data": [
    {
      "_ref": "item-1",
      "id": "12345",
      "downstream_id": "12345",
      "status": "created",
      "error": {
        "status_code": 502,
        "error": "Bad Gateway",
        "type_name": "PostWriteProcessingError",
        "message": "The record was written, but processing its response failed.",
        "ref": "https://developers.apideck.com/errors#postwriteprocessingerror"
      },
      "warnings": [
        {
          "type": "currency_not_configured",
          "operation": "invoicesAdd",
          "message": "Currency \"CAD\" is not configured for this organization -- the request was sent without currency_id.",
          "status_code": 200
        }
      ]
    }
  ]
}

Changes