Get Started
Portal api methods
Help

POST api/2.0/crm/invoice This function requires authentication

Description

Creates the invoice with the parameters (contactId, consigneeId, etc.) specified in the request

Parameters
Name Description Type Example
number
sent in body
Invoice number string some text
issueDate
sent in body
Invoice issue date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
templateType
sent in body
Invoice template type
optional
number 1234
contactId
sent in body
Invoice contact ID number 1234
consigneeId
sent in body
Invoice consignee ID
optional
number 1234
entityId
sent in body
Invoice entity ID
optional
number 1234
billingAddressID
sent in body
Invoice billing address ID
optional
number 1234
deliveryAddressID
sent in body
Invoice delivery address ID
optional
number 1234
dueDate
sent in body
Invoice due date Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
language
sent in body
Invoice language string some text
currency
sent in body
Invoice currency string some text
exchangeRate
sent in body
Invoice exchange rate System.Decimal
purchaseOrderNumber
sent in body
Invoice purchase order number
optional
string some text
terms
sent in body
Invoice terms string some text
description
sent in body
Invoice description
optional
string some text
invoiceLines
sent in body
Invoice lines list Collection of ASC.CRM.Core.Entities.InvoiceLines
collection
Example
            
            Data transfer in application/json format:
            
            data: {
               number: "invoice000001",
               issueDate: "2015-06-01T00:00:00",
               contactId: 10,
               dueDate: "2025-06-01T00:00:00",
               language: "es-ES",
               currency: "rub",
               exchangeRate: 54.32,
               terms: "Terms for this invoice",
               invoiceLines:
               [{
                     invoiceItemID: 1,
                     invoiceTax1ID: 1,
                     invoiceTax2ID: 2,
                     description: "description for invoice line 1",
                     quantity: 100,
                     price: 7.7,
                     discount: 25
               }]  
            }
            
            where invoiceItemID, invoiceTax1ID, invoiceTax2ID - ids of the real existing invoice item and invoice taxes,
            contactId - id of the existing contact
            
            
Returns

Invoice

Example Response

application/json

{
  "status": 0,
  "response": {
    "invoiceLines": [
      {
        "invoiceID": 0,
        "invoiceItemID": 0,
        "invoiceTax1ID": 0,
        "invoiceTax2ID": 0,
        "sortOrder": 0,
        "description": "",
        "quantity": 0,
        "price": 0.0,
        "discount": 0.0,
        "id": 0
      }
    ],
    "status": {
      "title": "Draft",
      "id": 1
    },
    "number": "",
    "issueDate": "2019-08-20T06:39:08.6650269Z",
    "templateType": 0,
    "contact": null,
    "consignee": null,
    "entity": null,
    "dueDate": "2019-08-20T06:39:08.6650269Z",
    "language": "",
    "currency": {
      "title": "Chinese Yuan",
      "symbol": "¥",
      "abbreviation": "CNY",
      "cultureName": "CN",
      "isConvertable": true,
      "isBasic": false
    },
    "exchangeRate": 1.0,
    "purchaseOrderNumber": "",
    "terms": "",
    "description": "",
    "fileID": -1,
    "createOn": "2019-08-20T06:39:08.6650269Z",
    "createBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "cost": 0.0,
    "canEdit": true,
    "canDelete": true,
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <invoiceLines>
      <invoiceID>0</invoiceID>
      <invoiceItemID>0</invoiceItemID>
      <invoiceTax1ID>0</invoiceTax1ID>
      <invoiceTax2ID>0</invoiceTax2ID>
      <sortOrder>0</sortOrder>
      <description></description>
      <quantity>0</quantity>
      <price>0</price>
      <discount>0</discount>
      <id>0</id>
    </invoiceLines>
    <status>
      <title>Draft</title>
      <id>1</id>
    </status>
    <number></number>
    <issueDate>2019-08-20T06:39:08.6650269Z</issueDate>
    <templateType>0</templateType>
    <contact />
    <consignee />
    <entity />
    <dueDate>2019-08-20T06:39:08.6650269Z</dueDate>
    <language></language>
    <currency>
      <title>Chinese Yuan</title>
      <symbol>¥</symbol>
      <abbreviation>CNY</abbreviation>
      <cultureName>CN</cultureName>
      <isConvertable>true</isConvertable>
      <isBasic>false</isBasic>
    </currency>
    <exchangeRate>1</exchangeRate>
    <purchaseOrderNumber></purchaseOrderNumber>
    <terms></terms>
    <description></description>
    <fileID>-1</fileID>
    <createOn>2019-08-20T06:39:08.6650269Z</createOn>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <cost>0</cost>
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>