GET
/
api
/
sale-receipts
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "id": 1,
      "receiptDate": "2024-01-01T00:00:00Z",
      "receiptNumber": "SR-2024-001",
      "referenceNo": "REF-001",
      "customerId": 1,
      "customer": {
        "balance": 1500,
        "currencyCode": "USD",
        "openingBalance": 1000,
        "openingBalanceAt": "2024-01-01T00:00:00Z",
        "openingBalanceExchangeRate": 1,
        "openingBalanceBranchId": 1,
        "salutation": "Mr.",
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Acme Corporation",
        "displayName": "John Doe - Acme Corporation",
        "email": "[email protected]",
        "workPhone": "+1 (555) 123-4567",
        "personalPhone": "+1 (555) 987-6543",
        "website": "https://www.acme.com",
        "billingAddress1": "123 Business Ave",
        "billingAddress2": "Suite 100",
        "billingAddressCity": "New York",
        "billingAddressCountry": "United States",
        "billingAddressEmail": "[email protected]",
        "billingAddressPostcode": "10001",
        "billingAddressPhone": "+1 (555) 111-2222",
        "billingAddressState": "NY",
        "shippingAddress1": "456 Shipping St",
        "shippingAddress2": "Unit 200",
        "shippingAddressCity": "Los Angeles",
        "shippingAddressCountry": "United States",
        "shippingAddressEmail": "[email protected]",
        "shippingAddressPostcode": "90001",
        "shippingAddressPhone": "+1 (555) 333-4444",
        "shippingAddressState": "CA",
        "note": "Important client with regular monthly orders",
        "active": true,
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z",
        "localOpeningBalance": 1000,
        "closingBalance": 1500
      },
      "depositAccountId": 1,
      "depositAccount": {
        "id": 1,
        "name": "Cash Account",
        "slug": "cash-account",
        "code": "1001",
        "index": 1,
        "accountType": "bank",
        "accountTypeLabel": "Bank Account",
        "parentAccountId": null,
        "predefined": false,
        "currencyCode": "USD",
        "active": true,
        "bankBalance": 5000,
        "bankBalanceFormatted": "$5,000.00",
        "lastFeedsUpdatedAt": "2024-03-20T10:30:00Z",
        "lastFeedsUpdatedAtFormatted": "Mar 20, 2024 10:30 AM",
        "amount": 5000,
        "formattedAmount": "$5,000.00",
        "plaidItemId": "plaid-item-123",
        "plaidAccountId": "plaid-account-456",
        "isFeedsActive": true,
        "isSyncingOwner": true,
        "isFeedsPaused": false,
        "accountNormal": "debit",
        "accountNormalFormatted": "Debit",
        "flattenName": "Assets: Cash Account",
        "accountLevel": 2,
        "createdAt": "2024-03-20T10:00:00Z",
        "updatedAt": "2024-03-20T10:30:00Z"
      },
      "exchangeRate": 1,
      "currencyCode": "USD",
      "receiptMessage": "Thank you for your payment",
      "statement": "Paid in full",
      "closed": false,
      "closedAt": "2024-01-02T00:00:00Z",
      "warehouseId": 1,
      "warehouse": {
        "name": "Main Warehouse",
        "code": "WH-001",
        "city": "New York",
        "country": "United States",
        "address": "123 Warehouse Street, New York, NY 10001",
        "primary": true
      },
      "branchId": 1,
      "branch": {
        "id": 1,
        "name": "Main Branch",
        "code": "BR001",
        "address": "123 Main Street",
        "city": "New York",
        "country": "USA",
        "phoneNumber": "+1-555-123-4567",
        "email": "[email protected]",
        "website": "https://www.example.com/branch",
        "primary": true,
        "createdAt": "2024-03-20T10:00:00Z",
        "updatedAt": "2024-03-20T10:00:00Z"
      },
      "entries": [
        {
          "index": 1,
          "itemId": 1,
          "rate": 1,
          "quantity": 1,
          "discount": 1,
          "discountType": "percentage",
          "description": "This is a description",
          "taxCode": "123456",
          "taxRateId": 1,
          "warehouseId": 1,
          "projectId": 1,
          "projectRefId": 1,
          "projectRefType": "TASK",
          "projectRefInvoicedAmount": 100,
          "sellAccountId": 1020,
          "costAccountId": 1021
        }
      ],
      "attachments": [
        {}
      ],
      "discount": 100,
      "discountType": "percentage",
      "adjustment": 50,
      "subtotal": 900,
      "subtotalLocal": 900,
      "subtotalFormatted": "900.00",
      "subtotalLocalFormatted": "900.00",
      "total": 1000,
      "totalLocal": 1000,
      "totalFormatted": "1,000.00",
      "totalLocalFormatted": "1,000.00",
      "formattedAmount": "1,000.00",
      "formattedReceiptDate": "2024-01-01",
      "formattedClosedAtDate": "2024-01-02",
      "formattedCreatedAt": "2024-01-01",
      "discountAmountFormatted": "100.00",
      "discountPercentageFormatted": "10%",
      "adjustmentFormatted": "50.00",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-02T00:00:00Z"
    }
  ]
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The response is of type object.