Business API Help

GET api/v1/liquidations?DocType={DocType}&Number={Number}&SerieID={SerieID}&SerieCode={SerieCode}&EntityID={EntityID}&MinDate={MinDate}&MaxDate={MaxDate}&Ordering={Ordering}&Desc={Desc}&Skip={Skip}&Take={Take}

Gets all the invoices based on the Document Type that you're trying to access. This type is based on the endpoint you're requesting on.

Request Information

URI Parameters

Name Description Type Additional information
DocType Fill this parameter if you want to GET all the liquidations by this type. NULL if you want everything DocumentType No additional information available.
Number Fill if you want to GET all the sales by the number you want. NULL if you want all numbers integer No additional information available.
SerieID Fill if you want to GET all the sales by the ID of the serie that you want. NULL if you want all series integer No additional information available.
SerieCode Fill if you want to GET all the sales by the Code of the serie. NULL if you want all series string No additional information available.
EntityID Search liquidations by entityID integer No additional information available.
MinDate Minimum date where the liquidation was made date No additional information available.
MaxDate Maximum date where the liquidation was made date No additional information available.
Ordering OrderOptions No additional information available.
Desc boolean No additional information available.
Skip How many items you want to skip. Usually we skip the item amount we already have integer No additional information available.
Take Number of items you want per page integer Range: inclusive between 0 and 50

Response Information

Resource Description

No information available

Name Description Type Additional information
LiquidationID integer No additional information available.
DocumentTypeID byte No additional information available.
DocumentTypeName string No additional information available.
Number integer No additional information available.
Serie SerieSimpleInfo No additional information available.
LiquidationDate date No additional information available.
EntityID integer No additional information available.
ReceivedAmount decimal number No additional information available.
DiscountAmount decimal number No additional information available.
CreatorUserID integer No additional information available.
CreationDate date No additional information available.
Observation string No additional information available.
DetailList Array of LiquidationDetailInfo No additional information available.

Response Formats

application/json, text/json

Sample: 
                    
[
  {
    "liquidationID": 1,
    "documentTypeID": 64,
    "documentTypeName": "sample string 3",
    "number": 4,
    "serie": {
      "serieID": 1,
      "name": "sample string 2",
      "code": "sample string 3"
    },
    "liquidationDate": "2022-08-15T07:10:10.6300416+01:00",
    "entityID": 6,
    "receivedAmount": 7.0,
    "discountAmount": 8.0,
    "creatorUserID": 9,
    "creationDate": "2022-08-15T07:10:10.6300416+01:00",
    "observation": "sample string 11",
    "detailList": [
      {
        "saleID": 1,
        "receivedAmount": 2.0,
        "totalOriginal": 3.0,
        "pendingOriginal": 4.0,
        "pendingAmount": 5.0,
        "discountAmount": 6.0
      },
      {
        "saleID": 1,
        "receivedAmount": 2.0,
        "totalOriginal": 3.0,
        "pendingOriginal": 4.0,
        "pendingAmount": 5.0,
        "discountAmount": 6.0
      }
    ]
  },
  {
    "liquidationID": 1,
    "documentTypeID": 64,
    "documentTypeName": "sample string 3",
    "number": 4,
    "serie": {
      "serieID": 1,
      "name": "sample string 2",
      "code": "sample string 3"
    },
    "liquidationDate": "2022-08-15T07:10:10.6300416+01:00",
    "entityID": 6,
    "receivedAmount": 7.0,
    "discountAmount": 8.0,
    "creatorUserID": 9,
    "creationDate": "2022-08-15T07:10:10.6300416+01:00",
    "observation": "sample string 11",
    "detailList": [
      {
        "saleID": 1,
        "receivedAmount": 2.0,
        "totalOriginal": 3.0,
        "pendingOriginal": 4.0,
        "pendingAmount": 5.0,
        "discountAmount": 6.0
      },
      {
        "saleID": 1,
        "receivedAmount": 2.0,
        "totalOriginal": 3.0,
        "pendingOriginal": 4.0,
        "pendingAmount": 5.0,
        "discountAmount": 6.0
      }
    ]
  }
]