Skip to content

Latest commit

 

History

History
208 lines (203 loc) · 9.79 KB

accountinginvoicesaddrequest.md

File metadata and controls

208 lines (203 loc) · 9.79 KB

AccountingInvoicesAddRequest

Example Usage

import { AccountingInvoicesAddRequest } from "@apideck/unify/models/operations";
import { RFCDate } from "@apideck/unify/types";

let value: AccountingInvoicesAddRequest = {
  serviceId: "salesforce",
  invoice: {
    type: "service",
    number: "OIT00546",
    customer: {
      id: "12345",
      displayName: "Windsurf Shop",
      email: "[email protected]",
    },
    companyId: "12345",
    invoiceDate: new RFCDate("2020-09-30"),
    dueDate: new RFCDate("2020-09-30"),
    terms: "Net 30 days",
    poNumber: "90000117",
    reference: "123456",
    status: "draft",
    invoiceSent: true,
    currency: "USD",
    currencyRate: 0.69,
    taxInclusive: true,
    subTotal: 27500,
    totalTax: 2500,
    taxCode: "1234",
    discountPercentage: 5.5,
    discountAmount: 25,
    total: 27500,
    balance: 27500,
    deposit: 0,
    customerMemo: "Thank you for your business and have a great day!",
    trackingCategories: [
      {
        id: "123456",
        name: "New York",
      },
    ],
    lineItems: [
      {
        id: "12345",
        rowId: "12345",
        code: "120-C",
        lineNumber: 1,
        description:
          "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
        type: "sales_item",
        taxAmount: 27500,
        totalAmount: 27500,
        quantity: 1,
        unitPrice: 27500.5,
        unitOfMeasure: "pc.",
        discountPercentage: 0.01,
        discountAmount: 19.99,
        locationId: "1234",
        departmentId: "1234",
        item: {
          id: "12344",
          code: "120-C",
          name: "Model Y",
        },
        taxRate: {
          id: "123456",
          rate: 10,
        },
        trackingCategories: [
          {
            id: "123456",
            name: "New York",
          },
        ],
        ledgerAccount: {
          id: "123456",
          nominalCode: "N091",
          code: "453",
        },
        customFields: [
          {
            id: "2389328923893298",
            name: "employee_level",
            description: "Employee Level",
            value: [
              "<value>",
            ],
          },
        ],
        rowVersion: "1-12345",
      },
    ],
    billingAddress: {
      id: "123",
      type: "primary",
      string: "25 Spring Street, Blackburn, VIC 3130",
      name: "HQ US",
      line1: "Main street",
      line2: "apt #",
      line3: "Suite #",
      line4: "delivery instructions",
      streetNumber: "25",
      city: "San Francisco",
      state: "CA",
      postalCode: "94104",
      country: "US",
      latitude: "40.759211",
      longitude: "-73.984638",
      county: "Santa Clara",
      contactName: "Elon Musk",
      salutation: "Mr",
      phoneNumber: "111-111-1111",
      fax: "122-111-1111",
      email: "[email protected]",
      website: "https://elonmusk.com",
      notes: "Address notes or delivery instructions.",
      rowVersion: "1-12345",
    },
    shippingAddress: {
      id: "123",
      type: "primary",
      string: "25 Spring Street, Blackburn, VIC 3130",
      name: "HQ US",
      line1: "Main street",
      line2: "apt #",
      line3: "Suite #",
      line4: "delivery instructions",
      streetNumber: "25",
      city: "San Francisco",
      state: "CA",
      postalCode: "94104",
      country: "US",
      latitude: "40.759211",
      longitude: "-73.984638",
      county: "Santa Clara",
      contactName: "Elon Musk",
      salutation: "Mr",
      phoneNumber: "111-111-1111",
      fax: "122-111-1111",
      email: "[email protected]",
      website: "https://elonmusk.com",
      notes: "Address notes or delivery instructions.",
      rowVersion: "1-12345",
    },
    templateId: "123456",
    sourceDocumentUrl: "https://www.invoicesolution.com/invoice/123456",
    paymentMethod: "cash",
    channel: "email",
    language: "EN",
    accountingByRow: false,
    bankAccount: {
      bankName: "Monzo",
      accountNumber: "123465",
      accountName: "SPACEX LLC",
      accountType: "credit_card",
      iban: "CH2989144532982975332",
      bic: "AUDSCHGGXXX",
      routingNumber: "012345678",
      bsbNumber: "062-001",
      branchIdentifier: "001",
      bankCode: "BNH",
      currency: "USD",
    },
    ledgerAccount: {
      id: "123456",
      nominalCode: "N091",
      code: "453",
    },
    customFields: [
      {
        id: "2389328923893298",
        name: "employee_level",
        description: "Employee Level",
        value: true,
      },
    ],
    rowVersion: "1-12345",
    passThrough: [
      {
        serviceId: "<id>",
        extendPaths: [
          {
            path: "$.nested.property",
            value: {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000",
              },
            },
          },
        ],
      },
    ],
  },
};

Fields

Field Type Required Description Example
raw boolean Include raw response. Mostly used for debugging purposes
consumerId string ID of the consumer which you want to get or push data from test-consumer
appId string The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
serviceId string Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
invoice components.InvoiceInput ✔️ N/A