Запись опубликована:08.10.2022
Post category:Счета
Запись изменена:03.11.2022

POST api/2.0/crm/invoice

Для этой функции требуется аутентификация.

Описание
Создает счет с указанными в запросе параметрами (идентификатор контакта, идентификатор грузополучателя и т.д.).

Параметры

Название	Описание	Тип	Пример
number sent in body	Номер счета	строковый	текст
issueDate sent in body	Дата выставления счета	дата и время	Roundtrip format: 2008-04-10T06-30-00.000Z
templateType sent in body	Тип шаблона счета необязательно	номер	1234
contactId sent in body	Invoice contact ID ?	номер	1234
consigneeId sent in body	Идентификатор получателя счета-фактуры необязательно	номер	1234
entityId sent in body	Идентификатор сущности счета необязательно	номер	1234
billingAddressID sent in body	Идентификатор адреса выставления счета необязательно	номер	1234
deliveryAddressID sent in body	Идентификатор адреса доставки счета необязательно	номер	1234
dueDate sent in body	Срок оплаты счета	дата и время	Roundtrip format: 2008-04-10T06-30-00.000Z
language sent in body	Язык счета	строковый	текст
currency sent in body	Валюта счета (аббревиатура) Допустимые значения: EUR, RUB и т.д. Весь список доступных валют можно получить по API	строковый	текст
exchangeRate sent in body	Обменный курс счета-фактуры	System.Decimal
purchaseOrderNumber sent in body	Номер заказа на покупку счета-фактуры необязательно	строковый	текст
terms sent in body	Условия счета	строковый	текст
description sent in body	Описание счета необязательно	строковый	текст
invoiceLines sent in body	Список строк счета	Collection of ASC.CRM.Core.Entities.InvoiceLines collection

Пример

            
            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.

Возвращает
Счет

Пример ответа

application/json

{
  "status": 0,
  "response": {
    "invoiceLines": [
      {
        "invoiceID": 0,
        "invoiceItemID": 0,
        "invoiceTax1ID": 0,
        "invoiceTax2ID": 0,
        "sortOrder": 0,
        "description": "",
        "quantity": 0.0,
        "price": 0.0,
        "discount": 0.0,
        "id": 0
      }
    ],
    "status": {
      "title": "Draft",
      "id": 1
    },
    "number": "",
    "issueDate": "2022-10-08T15:03:33.4143879Z",
    "templateType": 0,
    "contact": null,
    "consignee": null,
    "entity": null,
    "dueDate": "2022-10-08T15:03:33.4143879Z",
    "language": "",
    "currency": {
      "title": "Chinese Yuan",
      "symbol": "¥",
      "abbreviation": "CNY",
      "cultureName": "CN",
      "isConvertable": true,
      "isBasic": false
    },
    "exchangeRate": 1.0,
    "purchaseOrderNumber": "",
    "terms": "",
    "description": "",
    "fileID": -1,
    "createOn": "2022-10-08T15:03:33.4143879Z",
    "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>2022-10-08T15:03:33.4143879Z</issueDate>
    <templateType>0</templateType>
    <contact />
    <consignee />
    <entity />
    <dueDate>2022-10-08T15:03:33.4143879Z</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>2022-10-08T15:03:33.4143879Z</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>